Doc fixes.
h3rald h3rald@h3rald.com
Wed, 30 Dec 2020 20:13:17 +0000
4 files changed,
26 insertions(+),
12 deletions(-)
M
site/contents/reference-dstore.md
→
site/contents/reference-dstore.md
@@ -6,22 +6,22 @@ {@ _defs_.md || 0 @}
{#op||dsdelete||{{dstore}} {{sl}}||{{dstore}}|| Removes an item from the datastore {{dstore}}. The item is uniquely identified by {{sl}}, which contains the collection containing the item and the item id, separated by a forward slash (/). Puts the reference to the modified datastore back on tbe stack. -#} + #} {#op||dsget||{{dstore}} {{sl}}||{{d}}|| Retrieves item {{d}} from datastore {{dstore}}. {{d}} is retrieved by specifying {{sl}}, which contains the collection containing the item and the item id, separated by a forward slash (/). -#} + #} {#op||dsinit||{{sl}}||{{dstore}}|| Initializes a bew datastore by creating the {{sl}} JSON file. Puts the datastore instance on the stack. #} {#op||dspost||{{dstore}} {{sl}} {{d}}||{{dstore}}|| Adds the dictionary {{d}} to the datastore {{dstore}} inside collection {{sl}}, generating and adding a unique **id** field to {{d}}. If the collection {{sl}} does not exist it is created. Puts the reference to the modified datastore back on tbe stack. -#} + #} {#op||dsput||{{dstore}} {{sl}} {{d}}||{{dstore}}|| Adds the dictionary {{d}} to the datastore {{dstore}}. {{sl}} contains the collection where {{d}} will be placed and the id of {{d}}, separated by a forward slash (/). If the collection {{sl}} does not exist it is created. Puts the reference to the modified datastore back on tbe stack. -#} + #} {#op||dsquery||{{dstore}} {{sl}} {{q}}||({{d0p}})|| > Retrieves a quotation of dictionaries from the collection {{sl}} of datastore {{dstore}} obtained by applying {{q}} as a filter to each item of the collection, picking only the elements that match the filter.@@ -32,14 +32,13 @@ > >
> > Assuming that **ds** is a datastore, the following program retrieves all elements of teh collection **posts** whose author field is set to "h3rald": > > > > ds "posts" (/author "h3rald" ==) dsquery -#} + #} {#op||dsread||{{sl}}||{{dstore}}|| Reads the previously-created datastore from the file {{sl}} and puts the resulting datastore instance on the stack. -#} + #} {#op||dswrite||{{dstore}}||{{dstore}}|| Writes the contents of the datastore {{dstore}} to the filesystem. -#} - + #}
M
site/contents/reference-io.md
→
site/contents/reference-io.md
@@ -28,8 +28,14 @@
{#op||debug||{{any}}||{{any}}|| Prints {{any}} and a new line to STDOUT, if logging level is set to [debug](class:kwd) or lower.#} +{#op||debug!||{{any}}||{{none}}|| +Prints {{any}} (removing it from the stack) and a new line to STDOUT, if logging level is set to [debug](class:kwd) or lower.#} + {#op||error||{{any}}||{{any}}|| Prints {{any}} and a new line to STDERR, if logging level is set to [error](class:kwd) or lower.#} + +{#op||error!||{{any}}||{{none}}|| +Prints {{any}} (removing it from the stack) and a new line to STDERR, if logging level is set to [error](class:kwd) or lower.#} {#op||fappend||{{s1}} {{s2}}||{{none}}|| Appends {{s1}} to the end of file {{s2}}. #}@@ -48,6 +54,9 @@ Reads single character from STDIN without waiting for ENTER key and places its ASCII code on top of the stack.#}
{#op||info||{{any}}||{{any}}|| Prints {{any}} and a new line to STDOUT, if logging level is set to [info](class:kwd) or lower.#} + +{#op||info!||{{any}}||{{none}}|| +Prints {{any}} (removing it from the stack) and a new line to STDOUT, if logging level is set to [info](class:kwd) or lower.#} {#op||mapkey||{{q}} {{sl}}||{{none}}|| > Maps the named key/key combination {{sl}} to the quotation {{q}}, so that {{q}} is executed when key {{sl}} is pressed.@@ -73,6 +82,9 @@
{#op||notice||{{any}}||{{any}}|| Prints {{any}} and a new line to STDOUT, if logging level is set to [notice](class:kwd) (default) or lower.#} +{#op||notice!||{{any}}||{{none}}|| +Prints {{any}} (removing it from the stack) and a new line to STDOUT, if logging level is set to [notice](class:kwd) (default) or lower.#} + {#op||password||{{none}}||{{s}}|| Reads a line from STDIN displaying \* for each typed character, and places it on top of the stack as a string.#}@@ -96,7 +108,10 @@ > > Notes
> > > > * At present, only the key names and sequences defined in the [nimline](https://h3rald.com/nimline/nimline.html) library are supported. > > * At present, all the default mappings of min are those provided by the [nimline](https://h3rald.com/nimline/nimline.html) library. -#} + #} {#op||warning||{{any}}||{{any}}|| Prints {{any}} and a new line to STDERR, if logging level is set to [warning](class:kwd) or lower.#} + +{#op||warning!||{{any}}||{{none}}|| +Prints {{any}} (removing it from the stack) and a new line to STDERR, if logging level is set to [warning](class:kwd) or lower.#}
M
site/contents/reference-lang.md
→
site/contents/reference-lang.md
@@ -409,7 +409,7 @@ > > %tip%
> > Tip > > > > This symbol is very useful in conjunction with the **with** operator. -#} + #} {#op||save-symbol||{{sl}}||{{none}}|| Saves the contents of symbol {{sl}} to the [.min\_symbols](class:file) file. #}@@ -577,4 +577,4 @@ > > 'net import
> > 'http import > > ) ROOT with > > ) unless -#} + #}
M
site/contents/reference.md
→
site/contents/reference.md
@@ -77,7 +77,7 @@ "h3rald" :hostname
"" :port "" :username "" :password - "min" :path + "/min" :path "" :anchor "" :query }