add a note about the WHITESPACE and COMMENT inner rules

pest-parser · Feb 7, 2024 · f4ad611 · f4ad611
1 parent f09d149
commit f4ad611
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/grammars/syntax.md b/src/grammars/syntax.md
@@ -313,6 +313,14 @@ main = { SOI ~ expression ~ EOI }
 (Be sure to mark the `WHITESPACE` and `COMMENT` rules as [silent] unless you
 want to see them included inside other rules!)
 
+If you want the `WHITESPACE` and `COMMENT` inner rules included,
+note that you need to mark the rule with an explicit `$`:
+
+```
+COMMENT = ${ SingleLineComment }
+SingleLineComment = { "//" ~ (!"\n" ~ ANY)* }
+```
+
 [sequence]: #sequence
 [repetition]: #repetition
 [atomic rules]: #atomic