Building Intelligible Systems
summary
Clojure codebases become intelligible by shipping runnable examples and clearer errors: include runnable REPL sessions or literal data examples immediately after the ns form (Regal uses this), put realistic sample maps in docstrings, use spec or test.check generators for letter-style validation, or the Lambda Island library fizzai to produce realistic sample values in a factories file. For Java interop, provide thin wrappers and catch and rewrap Java exceptions into descriptive Clojure-friendly messages; use doctests to keep examples executable and documentation from drifting.
AI-written summary · about
chapters (12)
- 0:00Start
- 6:51Reply Sessions
- 8:31Transparent Data Structures
- 9:42Types and Type Based Approaches
- 10:02Type Closure
- 11:18Doc String
- 15:24Fizzai
- 16:17Dock Tests
- 16:27Python Doc Test
- 17:01Interop
- 18:16Wrapping Exceptions
- 19:09Using Error Messages
