Visualize.Audit.Headings (Visualize v0.8.0)

Copy Markdown View Source

The heading discipline spec/README.md §5 asks for, checked mechanically: one # title, a **Status:** line on line 3, and decimal numbering that is gap-free at every level (## 1., ### 1.1, #### 1.1.1). A lost or duplicated heading breaks the citations every other document and the golden's Section column rely on, and nobody notices by eye.

Tables too (#599): outside a code fence, a run of | rows starts with a header and a separator row, and no row leaves its first cell blank. Rows cut off from their table by a blank line or a paragraph render as literal | text, and merges that append rows at the end of a section are how they get cut off.

Summary

Functions

Problems in one document, as file: message strings.

Problems across every document under root/spec; [] when the discipline holds.

Functions

check(markdown, file)

@spec check(String.t(), String.t()) :: [String.t()]

Problems in one document, as file: message strings.

run(root)

@spec run(String.t()) :: [String.t()]

Problems across every document under root/spec; [] when the discipline holds.