Module manifest
Expand description
examples/parity.toml — the single source of what must agree.
The grammar is docs/design/11-documentation-plan.md §17.5. Every rule in it
is a rejection here, because the manifest’s job is to make silent exclusion
impossible (§6.2): an example that is in neither a pair nor an unpaired
entry is a parse error, so adding an example forces a decision about it.
Structs§
Enums§
- Arm 🔒
- Which language an
unpairedentry names.
Constants§
- MANIFEST
- The manifest, relative to the repository root.
- NOT_
EXAMPLES 🔒 - Directory names never descended into while listing examples.
- PYTHON_
DIR - Where the Python arms live, relative to the repository root.
- PYTHON_
NON_ 🔒EXAMPLES - The Python files under
PYTHON_DIRthat are harness, not examples. - RUST_
DIR - Where the Rust arms live, relative to the repository root.
Functions§
- array_
of_ 🔒tables - Returns the tables of an array-of-tables key.
- forbid_
fused_ 🔒multiply_ add - Fails when a paired Rust arm computes with a fused multiply-add.
- require_
file 🔒 - Fails when a named file does not exist.
- required_
string 🔒 - Reads a required string field.
- rust_
sources - Every Rust example source under
RUST_DIR, as/-separated relative paths. - sources 🔒
- Every file with
extensionunderpath, relative to it and/-separated. - string_
value 🔒 - Reads a string field’s value.
- unclaimed 🔒
- Fails when a file on disk appears in no entry.