diff options
author | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-09-12 10:04:04 +0200 |
---|---|---|
committer | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-09-12 10:04:04 +0200 |
commit | 475307bc9926898e769c7ad6fa3a844853b07f52 (patch) | |
tree | aa7610aaf3e7768ff8410d080364e0baeb42cd1a /module | |
parent | Fix bug causing for's continue to not work. (diff) | |
download | calp-475307bc9926898e769c7ad6fa3a844853b07f52.tar.gz calp-475307bc9926898e769c7ad6fa3a844853b07f52.tar.xz |
Add a bunch of documentation.
Diffstat (limited to 'module')
-rw-r--r-- | module/hnh/util.scm | 2 | ||||
-rw-r--r-- | module/scripts/find-undocumented.scm | 23 | ||||
-rw-r--r-- | module/vulgar/color.scm | 1 |
3 files changed, 21 insertions, 5 deletions
diff --git a/module/hnh/util.scm b/module/hnh/util.scm index 4bd06d11..91c081e2 100644 --- a/module/hnh/util.scm +++ b/module/hnh/util.scm @@ -6,7 +6,6 @@ :use-module ((srfi srfi-9 gnu) :select (set-fields)) :use-module ((ice-9 copy-tree) :select (copy-tree)) :use-module ((ice-9 control) :select (call/ec)) - :re-export (fold-values) :export (aif awhen for @@ -60,7 +59,6 @@ uniqx uniq univ - uniqv unique vector-last diff --git a/module/scripts/find-undocumented.scm b/module/scripts/find-undocumented.scm index 499f18d6..5aebcb25 100644 --- a/module/scripts/find-undocumented.scm +++ b/module/scripts/find-undocumented.scm @@ -7,6 +7,7 @@ :use-module (ice-9 regex) :use-module (ice-9 rdelim) :use-module (rnrs records syntactic) + :use-module (glob) :export (main) ) @@ -103,8 +104,20 @@ (define source-directory "module") (define doc-dir "doc/ref") (define skip-files - '("module/graphvis.scm" - "module/glob.scm")) + (append + '( + ;; Ignored since we arent't the implementor. + ;; It could however be nice to document it + "module/graphviz.scm" + ) + ;; Each entry-point should only export a main procedure, + ;; and is documented elsewhere + (glob "module/calp/entry-points/*.scm") + ;; These are scripts for `guild`. + ;; Each file exports a few pre-defined symbols, + ;; and are documented in other ways. + (glob "module/scripts/*.scm") + )) (define documented-symbols (concatenate @@ -130,6 +143,12 @@ (concatenate (for path in (all-modules-under-directory source-directory) (when (member path skip-files) + (continue '())) + + (define components* + (drop (path-split path) + (length (path-split source-directory)))) + (define name (map string->symbol (append (drop-right components* 1) diff --git a/module/vulgar/color.scm b/module/vulgar/color.scm index 5f9fbe40..91bd977f 100644 --- a/module/vulgar/color.scm +++ b/module/vulgar/color.scm @@ -1,7 +1,6 @@ (define-module (vulgar color) :export (color-if color-escape)) -(define-public STR-YELLOW "\x1b[0;33m") (define-public STR-RESET "\x1b[m") (define-syntax-rule (color-if pred color body ...) |