aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorcolin <colin@cicadas.surf>2023-08-08 07:23:02 -0700
committercolin <colin@cicadas.surf>2023-08-08 07:23:02 -0700
commit911e5868ab281a1fdb82b84b63aa35411933ceae (patch)
treeab6495673f1efdeaa597b78cfd74b946b2402c02 /README.org
parent0f42ae0e6d61e344e10604bc9b82f033fcdb91c9 (diff)
changed :doc to :note in rule specs
Diffstat (limited to 'README.org')
-rw-r--r--README.org14
1 files changed, 11 insertions, 3 deletions
diff --git a/README.org b/README.org
index e345bcf..9a8b710 100644
--- a/README.org
+++ b/README.org
@@ -21,10 +21,12 @@ In ~/examples/calc.lisp~ you see the following ~deflanguage~:
(<expr>
:match (:or <subexpr> <value> <unop> <binop>))
(<subexpr>
- :match (:{} calc))
+ :match (:{} calc)
+ :doc "A subexpression, like (1 + 2 / cos(1.5))")
(<value>
:match (:item)
- :if numberp)
+ :if numberp
+ :doc "A Number")
(<binop>
:match (:seq
(:@ lhs <expr>)
@@ -75,7 +77,11 @@ Function:
<VALUE> ::= ::TOKEN::
<BINOP> ::= <EXPR> ('+' | '-' | '/' | '*' | '^' | '%') <EXPR>⁤+
<UNOP> ::= ('SIN' | 'COS' | 'TAN' | '-') <EXPR>
-
+------------------------------------------
+ADDITIONAL NOTES:
+<SUBEXPR> A subexpression, like (1 + 2 / cos(1.5))
+<VALUE> A Number
+------------------------------------------
KEY:
::TOKEN:: Any ole token
::EOF:: Explicitly match the end of the input
@@ -213,3 +219,5 @@ clause, it can be either a function designator or an arbitrary expression.
When ~<rule3>~ succeeds, it returns a list of two values.
+*** Additional Docstrings
+