You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: design-docs/error-handling-implementation-plan.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,6 +63,7 @@
63
63
### WS8 – Documentation & Rollout
64
64
- Update README, API docs, and onboarding material to describe guarantees, exit codes, example snippets, and migration guidance for downstream tools.
65
65
- 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.
66
67
- Track adoption status in `design-docs/error-handling-implementation-plan.status.md` (mirror existing planning artifacts).
67
68
- Exit criteria: Documentation merged, status file created, ADR 0004 promoted to **Accepted** once WS2–WS7 land.
0 commit comments