Nitpick Programming Guide
Version: 0.34.7 Last Updated: 2026-05-28
Sections
| Section | Description |
|---|---|
| types/ | All Nitpick types — integers, floats, TBB, strings, structs, etc. |
| operators/ | Arithmetic, comparison, logical, bitwise, result, and special operators |
| result/ | Canonical Result handling cookbook: pass/fail, ?, ??, ?!, defaults, raw, drop, _?, _!, and contextual catch (v0.33.x) |
| dbc/ | Canonical Design by Contract cookbook: requires, ensures, invariant, prove, assert_static, limit<Rules>, failsafe workflow, and Z3 debugging (v0.34.x) |
| functions/ | Function declaration, main/failsafe, pass/fail, extern, generics |
| control_flow/ | if/else, for, while, loop/till, when, pick |
| memory/ | Regions, pointer operators, FFI pointer ABI, NULL failsafe, wild/wildx, GC interop, diagnostics |
| memory_model/ | Legacy stack/GC/wild allocation notes, Handle |
| traits/ | trait / impl / dyn T surface, dynamic dispatch, dyn-borrow rules (v0.31.1.x) |
| special-values/ | fixed / NIL / NULL / ERR / unknown, Result<T> + fail, pick exhaustiveness for special values, runtime taint + T?unknown (v0.31.2.x – v0.31.9.x) |
| modules/ | use/mod/pub/extern, package structure |
| collections/ | User stack (astack) and hash tables (ahash) |
| io_system/ | Print, file I/O, stdin, sys() syscalls, streams |
| standard_library/ | Standard library overview and builtins |
| advanced_features/ | Generics, traits, design by contract, closures, concurrency, verification, JIT |
| debugging/ | Debugging tools and strategies |
Building HTML
./md2html.py --all # Convert all .md files to html/
./md2man.py # Generate man pages
Source of Truth
- Language inventory:
specs/list.txt - Authoritative spec:
specs/nitpick_specs.txt - Archived old guide:
guide_archive/(372 files, pre-v0.4.7)