Skip to main content

description

Function description 

fn description(
    features: &Table,
    feature: &str,
    manifest: &str,
) -> Result<String, Error>
Expand description

The comment block above a feature, as prose — the part above D37’s marker.

D37. A feature’s comment is written for whoever maintains the flag, and §1.3.35 caught the consequence on a user-facing page: 19 internal shorthands (03-architecture.md §1, 09 §15, M6.3, D4) and one description that was a note about its own comment’s history. The comment is still the right source — it sits next to the code that reads the flag and cannot drift from it — so the fix is a split rather than a second file: everything above a line that is exactly # -- is published, everything below it is a maintainer note this function drops. One source of truth, in one place, with the audience marked.

§Errors

Error::Unclassifiable when nothing publishable remains — no comment block at all, or a marker with nothing above it. Fail-closed for the same reason §1.3.36 measured biting: an undescribed feature is a page that lies by omission.