From d098e1d2cb679516797fe3a9dee097cb6979cadd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hugo=20H=C3=B6rnquist?= Date: Sun, 10 Sep 2023 17:10:32 +0200 Subject: Document how find-undocumented's pattern builder work. --- module/scripts/find-undocumented.scm | 9 +++++++++ 1 file changed, 9 insertions(+) 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 ...) -- cgit v1.2.3