Add doc info on DSL code-comment syntax (#1165)

johnkerl · Dec 31, 2022 · b89371d · b89371d
1 parent 7bf358e
commit b89371d
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 4 deletions.
diff --git a/docs/src/dsl-example.mlr b/docs/src/dsl-example.mlr
@@ -1,2 +1,2 @@
-$cost = $quantity * $rate;
+$cost = $quantity * $rate; # Here is how to make a comment
 $index *= 100
diff --git a/docs/src/miller-programming-language.md b/docs/src/miller-programming-language.md
@@ -73,7 +73,7 @@ purple square   false 10 9100  72.3735  8.2430 596.5747605000001
 
 <pre class="pre-highlight-in-pair">
 <b>mlr --c2p put '</b>
-<b>  $cost = $quantity * $rate;</b>
+<b>  $cost = $quantity * $rate; # Here is how to make a comment</b>
 <b>  $index *= 100</b>
 <b>' example.csv</b>
 </pre>
@@ -91,13 +91,15 @@ yellow circle   true  9  8700  63.5058  8.3350 529.3208430000001
 purple square   false 10 9100  72.3735  8.2430 596.5747605000001
 </pre>
 
+Anything from a `#` character to end of line is a code comment.
+
 One of Miller's key features is the ability to express data-transformation right there at the keyboard, interactively. But if you find yourself using expressions repeatedly, you can put everything between the single quotes into a file and refer to that using `put -f`:
 
 <pre class="pre-highlight-in-pair">
 <b>cat dsl-example.mlr</b>
 </pre>
 <pre class="pre-non-highlight-in-pair">
-$cost = $quantity * $rate;
+$cost = $quantity * $rate; # Here is how to make a comment
 $index *= 100
 </pre>
 

diff --git a/docs/src/miller-programming-language.md.in b/docs/src/miller-programming-language.md.in
@@ -31,11 +31,13 @@ GENMD-EOF
 
 GENMD-RUN-COMMAND
 mlr --c2p put '
-  $cost = $quantity * $rate;
+  $cost = $quantity * $rate; # Here is how to make a comment
   $index *= 100
 ' example.csv
 GENMD-EOF
 
+Anything from a `#` character to end of line is a code comment.
+
 One of Miller's key features is the ability to express data-transformation right there at the keyboard, interactively. But if you find yourself using expressions repeatedly, you can put everything between the single quotes into a file and refer to that using `put -f`:
 
 GENMD-RUN-COMMAND

diff --git a/docs/src/reference-dsl-syntax.md b/docs/src/reference-dsl-syntax.md
@@ -41,6 +41,7 @@ Newlines within the expression are ignored, which can help increase legibility o
 
 <pre class="pre-highlight-in-pair">
 <b>mlr --opprint put '</b>
+<b>  # Here is how to make a comment</b>
 <b>  $nf       = NF;</b>
 <b>  $nr       = NR;</b>
 <b>  $fnr      = FNR;</b>
@@ -62,6 +63,8 @@ hat wye 10002 0.321507044286237609 0.568893318795083758 5  9  4   2       data/s
 pan zee 10003 0.272054845593895200 0.425789896597056627 5  10 5   2       data/small2
 </pre>
 
+Anything from a `#` character to end of line is a code comment.
+
 <pre class="pre-highlight-in-pair">
 <b>mlr --opprint filter '($x > 0.5 && $y < 0.5) || ($x < 0.5 && $y > 0.5)' \</b>
 <b>  then stats2 -a corr -f x,y \</b>

diff --git a/docs/src/reference-dsl-syntax.md.in b/docs/src/reference-dsl-syntax.md.in
@@ -12,6 +12,7 @@ Newlines within the expression are ignored, which can help increase legibility o
 
 GENMD-RUN-COMMAND
 mlr --opprint put '
+  # Here is how to make a comment
   $nf       = NF;
   $nr       = NR;
   $fnr      = FNR;
@@ -20,6 +21,8 @@ mlr --opprint put '
 ' data/small data/small2
 GENMD-EOF
 
+Anything from a `#` character to end of line is a code comment.
+
 GENMD-RUN-COMMAND
 mlr --opprint filter '($x > 0.5 && $y < 0.5) || ($x < 0.5 && $y > 0.5)' \
   then stats2 -a corr -f x,y \