Skip to main content

Module prose

Module prose 

Source
Expand description

Per-rule prose loader.

All editorial content (likely-cause templates, hypotheses, unknowns, next-step bullets, escalation-note copy, severity rationale) lives in prose.toml at the crate root, embedded into the binary via include_str! and parsed once on first access through OnceLock.

Rule logic in diagnose.rs references prose by rule name; mismatches between the two surface as a panic at first access (during tests, immediately on first use). This is the right severity: a missing prose key or malformed prose.toml is a programming error, not a runtime condition — and the test suite exercises every rule, so any drift fails cargo test rather than reaching production. The clippy::panic allow below is scoped to this load-time validation surface only.

Structs§

Prose
Top-level deserialized form of prose.toml.
RuleProse
Per-rule prose entry.

Functions§

prose
Access the parsed prose. Loaded and validated once on first call.