Skip to content

Commit 003935f

Browse files
committed
design-docs/error-handling-implementation-plan.md: More details about what docs need to be produced
Signed-off-by: Tzanko Matev <[email protected]>
1 parent a9ab079 commit 003935f

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

design-docs/error-handling-implementation-plan.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@
6363
### WS8 – Documentation & Rollout
6464
- Update README, API docs, and onboarding material to describe guarantees, exit codes, example snippets, and migration guidance for downstream tools.
6565
- Add a change log entry summarising the policy and how to consume structured errors from Python.
66+
- Document assertion guidance: prefer `bug!`/`ensure_internal!` for invariant violations, reserve `assert!` for tests, and pair `debug_assert!` with the classified error when you need both dev-time tripwires and production containment.
6667
- Track adoption status in `design-docs/error-handling-implementation-plan.status.md` (mirror existing planning artifacts).
6768
- Exit criteria: Documentation merged, status file created, ADR 0004 promoted to **Accepted** once WS2–WS7 land.
6869

0 commit comments

Comments
 (0)