Skip to main content

Module docs_parser

Module docs_parser 

Source
Expand description

Lenient parser for the machine-readable plot-block schema in docs/USAGE.md. See docs/USAGE-SCHEMA.md for the contract.

This module is intentionally dependency-free so it compiles and is tested in every feature combination (including the slim build).

Structs§

PlotEntry
A single plot:begin/plot:end block.
UsageDoc
A parsed usage document. Parsing never fails; problems are recorded as warnings and the rest of the document is still parsed.

Constants§

USAGE_SCHEMA_VERSION
The highest schema version this binary understands.

Functions§

parse_doc
Parse a usage document. Never fails; tolerant of malformed input.