amr/memex
1
0
Fork 0
Code Issues 12 Pull Requests Actions Packages Projects 1 Releases Wiki Activity

docs: document check-parens limitation with multi-block forms

Browse Source 
Some literate files split a single form across multiple blocks.
check-parens checks per-block, so these produce false positives.
Recommend check-tangle as an alternative for those files.
This commit is contained in:
Amr Gharbeia
2026-05-13 13:17:08 -04:00
parent a88dac5510
commit 2cc31a1381
1 changed files with 14 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
projects/check-parens/README.org
View File

@@ -3,8 +3,20 @@
Standalone parentheseis checker for Lisp source blocks in Org files.
Scans all ~#+begin_src lisp … #+end_src~ blocks in an Org file, strips
string and comment content, and reports unbalanced parentheses per block.
Scans all ~#+begin_src lisp … #+end_src~ blocks in an Org file, uses
SBCL's reader to validate each block. 100% accurate — no false positives
from string literals or character literals (e.g. ~#\)~).
== Limitations
Each ~#+begin_src lisp~ block is checked independently. Some literate
files intentionally split a single form (e.g. a ~defpackage~ with many
symbols) across multiple blocks with prose between them. In such cases
no individual block is self-contained and check-parens will report
false positives.
To verify these files, tangle and compile the resulting .lisp instead:
check-tangle <file.org>
== Usage