docs: ausgelieferte Doku zitiert keine Issue-Nummern mehr, docs verify prueft es (schliesst #77)
Files changed: - .gitignore - CHANGES.md - EVALS.md - INSTALL.md - README.md - VERSION - docs/pipeline-rationale.md - instructions/CONTRACT.md - instructions/bootstrap.md - instructions/dev/issue-tracking.md - instructions/evolve-subtypes.md - instructions/kb-profiles.md - instructions/mcp-read-server.md - instructions/wiki-ingest/SKILL.md - kb/CONTRACT.md - kb/concepts/COLLECTION.md - kb/sources/COLLECTION.md - raw/CONTRACT.md - tools/.coveragerc - tools/CONTRACT.md - tools/README.md - tools/chemenu/commands/docs_verify.py - tools/chemenu/tests/test_docs_verify.py - types/source.schema.yaml - types/type-spec.md
This commit is contained in:
+5
-1
@@ -79,7 +79,11 @@ bound at import time - `KB_DIR` and friends follow whatever `ROOT` currently is.
|
||||
2. Register it in `cli.py` (`app.add_typer(...)` or `app.command(...)`).
|
||||
3. Add a row to [CONTRACT.md](CONTRACT.md)'s command table **and** to its error
|
||||
contract table. `docs verify` fails in both directions - an undocumented
|
||||
command and a documented non-command are equally reported.
|
||||
command and a documented non-command are equally reported. Write the rows
|
||||
without citing an issue number: `docs verify` also refuses any `.md` or
|
||||
`.template` `dist export` ships that carries one, because the tracker exists
|
||||
only in this repo (`instructions/dev/issue-tracking.md` § Citing an issue in
|
||||
the repo).
|
||||
4. Add tests. Pure logic belongs in a function separate from the Typer callback
|
||||
(see `mass_update_gate_message`, `derive_run_key`, `run_export`), so a test
|
||||
does not need a CLI runner - and a Typer callback called directly from a test
|
||||
|
||||
Reference in New Issue
Block a user