Skip to content

Check the code map against the tree - #83

Merged
benoitc merged 1 commit into
mainfrom
code-map-check
Aug 29, 2026
Merged

Check the code map against the tree#83
benoitc merged 1 commit into
mainfrom
code-map-check

Conversation

@benoitc

@benoitc benoitc commented Aug 29, 2026

Copy link
Copy Markdown
Owner

A code map that drifts is worse than none, and nothing kept this one honest. This adds make check-code-map, run by the Lint job: every source file must be in the map, every Erlang module must have a moduledoc, and every module must have a row in a new Modules table in the coverage audit that names the suites exercising it. The first run found the gaps the page had already accumulated, which are fixed here.

A script, run by make and CI, that fails when a source file is
missing from docs/code-map.md, an Erlang module has no moduledoc,
or a module has no row in the new Modules table of the coverage
audit. Running it once found two modules, seven headers and two
Python files the map had missed.
@benoitc
benoitc merged commit 9458981 into main Aug 29, 2026
20 checks passed
@benoitc
benoitc deleted the code-map-check branch August 29, 2026 18:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant