Repository navigation
docs(docs): third whole-repo pass over the non-API docs (#1103) - #1832
Conversation
Counted numbers: - conventions, roadmap, workflow, release, index and package-index pages state no counts of codebase or docs items; measurements, spec values and code constants stay - documentation.rst states the no-counts rule in place of "re-derive a count", and no longer claims its sibling pages carry figure tests Accuracy: - the Create Release gate runs only once version_check has passed - the Test Results footnotes no longer say measured engines were unbuilt - mint-criterion's unmint split no longer contradicts itself Rendering: - pep.rst cross-references point at documented targets; third-party modules with no inventory render as literals - the layer and foundation base-class pages get distinct titles, and the root page has a single top-level heading - release_status outcomes and the conventions index read as lists Directives: - link/index.rst records the removed link-layer OSPF, RARP and DRARP names Refs #1103
|
Verdict: NEEDS CHANGES at
One blocking defect, which I re-checked by parsing the workflow. |
|
Fixed on |
Please follow the guide below
You will be asked some questions, please read them carefully and answer honestly
Put an
xinto all the boxes [ ] relevant to your pull request (like that [x])Use Preview tab to see how your pull request will actually look like
Searched for similar pull requests
Followed the coding style (
make pylint,make mypy,make isort)make testpasses, and a test case covers the change. Narrow runs only, listed below.Added a changelog entry under
docs/source/changelog/and regeneratedCHANGELOG.md, if the change is user-visible: N/A — centralised in docs(changelog): shared 1.5.0 changelog — long-lived, merges last (#610, #616, #617, #618, #620) #657What is the purpose of your pull request?
Tick the commit type your subject line carries.
fix— corrects a defectfeat— adds a featureperf— changes performance, not behaviourrefactor— changes neither behaviour nor performancetest— tests onlydocs— documentation onlyci— workflows or build toolingrelease— bumps the version or rolls up a distributionchore— anything elseCounted numbers:
state no counts of codebase or docs items; measurements, spec values and
code constants stay
count", and no longer claims its sibling pages carry figure tests
Accuracy:
Rendering:
modules with no inventory render as literals
root page has a single top-level heading
Directives:
Non-prose check:
ast.dumpis unchanged once docstrings are blanked; any workflow, TOML or script edits are comment-only (parsed and compared). Narrow test runs are green (tests/projectand the tests that read edited files).Refs #1103