Repository navigation
docs(contributing): cut the contributing pages and repair drifted line references - #1012
Conversation
…e references - Re-derives the `file:line` references into `.github/workflows/`, which had drifted by 50 to 200 lines. `create-release.yml`'s `unit-tests` job is at 148-155, not 142-149; `unit-tests.yml`'s `required-checks` is at 1141-1167 and its `changelog` job at 904-925. - Drops a pointer in `releasing.rst` saying the tag-push bypass is explained in the next section. That section is about skip cascades and never explained it, and the reason appears nowhere else in the subtree. - Cuts timed context per #719 — "today", "currently", "to date", "commented out since 2023", and a two-pass sweep narrative. Version-bounded breaking-change notes stay, including the one recording that four capture engines used to be in the `all` extra. - Concision across seven pages; four of the eleven are untouched. Citations are frozen: every `:issue:`/`:pr:`/`:discussion:` role, bare `#nnn` and issue URL is byte-identical per file. The `tests/`-and-changelog citation exemption and the paraphrase-the-ruling instruction both survive. `tests/project`: 268 passed, 1 skipped, 864 subtests passed. Part of #719.
c291e55 to
827b866
Compare
|
NEEDS CHANGES at
A breaking-change note had been cut, which #719 exempts. A claim of mine is withdrawn. I said a The review also independently re-derived 121 of 127 registries defining Separately filed rather than loaded onto this PR: 20 pre-existing nested-inline-markup defects across these pages, all present on |
|
Correcting a number in my comment above: I said 20 pre-existing nested-inline-markup defects across these pages. I measured it myself and get 12 — 8 with a literal or role inside I did not reproduce 20 with a detector that flattens wrapped spans and looks for What did warrant its own issue is #1013: |
|
GOOD TO GO at It also closed the test-count discrepancy from round 1: its 264/5 was its own harness, not the tree — it had measured from an unpacked archive with no Third and final correction to the nested-markup count, and the method is the point. I reported 20, then 12. Both were regex artefacts: the first cross-paired the closing So the figure is 7-8, not 20 and not 12, all present on |
make pylint,make mypy,make isort) — N/A, no Python changedmake testpasses, and a test case covers the change — I rantests/projectonly (268 passed, 1 skipped, 864 subtests), not the full suitedocs/source/changelog/and regeneratedCHANGELOG.md, if the change is user-visible — N/A, prose only, no user-visible behaviourWhat is the purpose of your pull request?
fix— corrects a defectfeat— adds a featureperf— changes performance, not behaviourrefactor— changes neither behaviour nor performancetest— tests onlydocs— documentation onlyci— workflows or build toolingchore— anything elseDescription of your pull request and other information
The
docs/source/contributing/slice of #719. −27 lines net across seven of the eleven pages;conventions/index.rst,extension-header-subclassing.rst,sentinel-convention.rstandtesting.rstare untouched.The accuracy half is the larger part of this. The
file:linereferences into.github/workflows/had drifted badly —create-release.ymlby 50 to 200 lines. I verified the rewritten ones rather than taking them on trust: 17 specific citations were read back against the real files and every one lands on the right construct (required-checks:atunit-tests.yml:1141, itsif:at:1144,changelog:at:904,gate:at:931, the fourenvironment:/needs:pairs increate-release.ymlat 345/348, 447/449, 522/527 and 623/626,tag_nameat 425, 603 and 843, the unreleased-changelog guard at 402). All 31 references in the subtree are in range for their target file.Also fixed: a
Compat Python ${{ matrix.python-version }}literal split across a source line break, which reST will not render as a literal. Andreleasing.rstcarried a pointer saying the tag-push bypass is explained "in the next section" — that section is about skip cascades and never explained it, so the dangling promise is gone rather than left pointing nowhere.Citations are frozen, per the ruling on #719 that they are design rationale rather than timed context. Every
:issue:/:pr:/:discussion:role, bare#nnnand issue URL is byte-identical per file. Two rulings recorded in this subtree were specifically protected and survive: that the changelog andtests/are exempt from the cite-the-issue rule, with the reasoning that undertests/the pull request is often the only durable pointer; and that a ruling is written in one's own words rather than quoted.Timed context is cut — "today", "currently", "to date", "commented out since 2023", a two-pass sweep narrative — while version-bounded breaking-change notes stay, including the two phrased as "used to".
Claims re-derived and found already correct, so left alone: 121 of the 127 registries define
_missing_;find_packagesreturns 73; the label count is 29; 12 mermaid directives on 11 pages; ruleset23497679's required contexts andstrict: true; the ESP, MH and SCTP member and handler counts; and the registered-but-not-dissected sizes inpep.rst.Not done: no Sphinx build was run for this slice, so there is no build evidence beyond
tests/project. The concision pass is also deliberately partial —pep.rst(1119 lines) and much ofregistry-protocol.rstgot only targeted cuts and could still be tightened.