From 2b1d466f1be430bc88c4051b88d5d73556363196 Mon Sep 17 00:00:00 2001 From: colin Date: Tue, 8 Aug 2023 07:25:00 -0700 Subject: note about note --- README.org | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'README.org') diff --git a/README.org b/README.org index 9a8b710..834faf8 100644 --- a/README.org +++ b/README.org @@ -219,5 +219,9 @@ clause, it can be either a function designator or an arbitrary expression. When ~~ succeeds, it returns a list of two values. -*** Additional Docstrings +*** NOTE clauses + +You can provide each rule with a ~:note~ keyword argument followed by +a string. This information will show up in the documentation string +for the macro being defined. These notes should be brief. -- cgit v1.2.3