diff options
| author | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-09-10 17:10:32 +0200 |
|---|---|---|
| committer | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-09-11 18:00:15 +0200 |
| commit | d098e1d2cb679516797fe3a9dee097cb6979cadd (patch) | |
| tree | bc01f35e2acbbcd3f5c323bec9dd13f65aba3054 | |
| parent | Expose eager-stream-cons. (diff) | |
| download | calp-d098e1d2cb679516797fe3a9dee097cb6979cadd.tar.gz calp-d098e1d2cb679516797fe3a9dee097cb6979cadd.tar.xz | |
Document how find-undocumented's pattern builder work.
| -rw-r--r-- | module/scripts/find-undocumented.scm | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/module/scripts/find-undocumented.scm b/module/scripts/find-undocumented.scm index 127baa74..01dde818 100644 --- a/module/scripts/find-undocumented.scm +++ b/module/scripts/find-undocumented.scm @@ -16,6 +16,15 @@ ;; (define %help "") +;;; All texinfo forms we want to capture. +;;; For each of these, the following grammar holds: +;;; - The first element should be a string of the texinfo tag to match +;;; - The following arguments are +;;; - Any number of `_`, meaning an argument we don't care about +;;; - a single instance of the symbol `name`, which indicates where the name of +;;; the definition is stored. +;;; - An optional final argument `...`, which indicates that more may argumnets +;;; may follow. (define texinfo-definition-forms '(("deffn" _ name ...) ("deftp" _ name ...) |