diff options
| author | colin <colin@cicadas.surf> | 2023-08-08 07:25:00 -0700 |
|---|---|---|
| committer | colin <colin@cicadas.surf> | 2023-08-08 07:25:00 -0700 |
| commit | 2b1d466f1be430bc88c4051b88d5d73556363196 (patch) | |
| tree | f8ce609e854d83294b8820d0ebbef6644694dcd8 /README.org | |
| parent | 911e5868ab281a1fdb82b84b63aa35411933ceae (diff) | |
note about note
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 6 |
1 files changed, 5 insertions, 1 deletions
@@ -219,5 +219,9 @@ clause, it can be either a function designator or an arbitrary expression. When ~<rule3>~ 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. |