Changeset 39605 in project

Timestamp:

02/23/21 07:54:21 (5 days ago)

Author:

dieggsy

Message:

chalk: update docs for v0.3.4

File:

• wiki/eggref/5/chalk (modified) (4 diffs)

wiki/eggref/5/chalk

@@ -15 +15 @@
 The following is hahn's fibonacci example, rewritten for chalk. Note key
 differences: The example is simply a string (and therefore not evaluated),
-whith the option of a {{@pre}} or {{@post}} caption. Additionally, the
-docstring must be contained within a single string and a heading is not
-generated for the procedure name.
+whith the option of a {{@pre}} or {{@post}} caption.
 
 <enscript highlight="scheme">
@@ -63 +61 @@
 
 <enscript>
-@("Description" [OPTION] ...)
-</enscript>
+@("Description" ... [OPTION] ...)
+</enscript>
+
+Multiple top-level strings in the docexpr are turned into separate wiki paragraphs.
 
 ==== Variables
@@ -98 +98 @@
 </enscript>
 
-In the case of procedures defined as variables, chalk considers it a variable
+In the case of procedures defined as variables, chalk considers them variables
 by default, using the function name as a signature. In either case, you can
 override the default signature with the tag {{@sig}}, and you can specify that
@@ -267 +267 @@
 === Version History
 
+; 0.3.4 : Allow multiple strings as description
 ; 0.3.3 : Reduce line spacing, change license options
 ; 0.3.2 : Add multi-line script support