Visualize.Audit.SpecScan (Visualize v0.2.25)

Copy Markdown View Source

Every function the specification declares: each `Module.function/arity` in the first cell of a table row under spec/*.md, with the numbered section it sits in.

The row grammar is the one spec/README.md §5 asks writers to keep: |Visualize.Scale.linear/0| contract |. Anything else in a table is not a declaration.

Summary

Types

entry()

Functions

run(root)

Every declaration under root/spec, in file then line order.

scan_source(markdown, file)

Scans one markdown document; file is the path the entries record.

Types

entry()

@type entry() :: %{item: String.t(), file: String.t(), section: String.t()}

Functions

run(root)

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

Every declaration under root/spec, in file then line order.

scan_source(markdown, file)

@spec scan_source(String.t(), String.t()) :: [entry()]

Scans one markdown document; file is the path the entries record.