Skip to main content

Module reference

Module reference 

Source
Expand description

Configuration reference generated from the schema itself.

A hand-written reference drifts: a default changes in code and nobody edits the table. Rendering it from conf’s introspection means it can only describe settings that exist, with the defaults they really have, and an application test that compares the rendering with the committed file fails when either moves alone.

Structs§

Reference
How one application’s schema maps onto its reference document.
TableKey
One key inside a whole-table setting.

Functions§

reference_markdown
Renders the reference: one Markdown table per top-level section, in schema order. The description is each field’s first doc paragraph; rationale below it stays in the source.