diff options
| author | Craig Jennings <c@cjennings.net> | 2025-11-01 21:39:52 -0500 |
|---|---|---|
| committer | Craig Jennings <c@cjennings.net> | 2025-11-01 21:39:52 -0500 |
| commit | e88ee8d911dc86a2a5d83ad12780c462c77d6f44 (patch) | |
| tree | 8438ed655fb5bc97df0b0b5ec92090d33fda68fc /docs/values-comparison.org | |
| parent | a734691b5c31135530c35423ad8ed2bbacb3b868 (diff) | |
| download | dotemacs-e88ee8d911dc86a2a5d83ad12780c462c77d6f44.tar.gz dotemacs-e88ee8d911dc86a2a5d83ad12780c462c77d6f44.zip | |
docs: Add Emacs Lisp development best practices to NOTES
Document lessons learned from chime-org-contacts.el development about
preventing parenthesis errors in Emacs Lisp code.
Key Topics:
- AI code generation strategies (small functions, immediate testing)
- Human developer tools (paredit, smartparens, rainbow-delimiters)
- Real-world case study from chime-org-contacts.el refactoring
- Tools and workflow summary table
Problem Identified:
Both AI and humans struggle with deeply nested Emacs Lisp functions
due to difficulty counting parentheses manually.
Solution Documented:
Break complex functions into small (< 15 line) helpers:
- Easier to verify correctness
- Easier to test independently
- Self-documenting through clear function names
- AI and humans both succeed
Tools Referenced:
- Structural editing: paredit, smartparens, lispy
- Real-time validation: flycheck, flymake
- Visual aids: rainbow-delimiters-mode
- CI/CD: pre-commit hooks with check-parens
This section serves as permanent reference for future Emacs Lisp
development in this repository and others.
Diffstat (limited to 'docs/values-comparison.org')
0 files changed, 0 insertions, 0 deletions
