Repository navigation
docs(contributing): cite the issue, not the pull request, on the conventions pages (#719) - #978
Conversation
…entions pages (#719) * `extension-header-subclassing.rst`: the second-base ruling now cites the rename issue it was given in review of, twice. No issue owns that ruling on its own. * `mint-criterion.rst`: the mint criterion and the company-name reasoning now cite the `Socket._missing_` fix's own issue rather than its pull request. * `registry-protocol.rst`: three citations re-pointed at the issue behind the change — the case-sensitivity audit, the `extend_enum` removal and the `EnumLookup` re-parenting. The two `mh.py` overrides' widening and their later deletion were each ruled in a review thread rather than on an issue, so both read as prose: the widening issue carries only the widening ruling, and citing it for the deletion pointed at the wrong thread. * `process.rst`: the `breaking` worked examples and the label census now cite issues or describe the change; the shared changelog is described rather than numbered, and its commit-count command looks the pull request up by title instead of hard-coding a number. Out of scope by the owner's rulings, not by my own caution: the changelog is exempt, so neither `docs/source/changelog/` (188 references) nor the top-level `docs/source/changelog.rst` summary (1) is touched — the latter repeats `0.14.3`'s `(#29, #30)` verbatim from the directory, so editing one would desynchronise the pair. `tests/**` is exempt too, and still cites pull requests in its own docstrings. Verified: `tests/project/test_conventions_doc_claims.py` 37 passed, 1 pre-existing skip; a full Sphinx build's warning set is byte-identical to the `main` baseline, 63 lines each, 0 new and 0 gone, 7 duplicate-label and 0 orphan both sides; every displayed `#NNN` matches its own URL and all 45 link targets are issues; over-88 lines under `docs/source/contributing/` went 23 to 22, with none added.
b4823c4 to
df61fce
Compare
|
GOOD TO GO at The deletion sentence is now true and its referent resolves locally. Issue It caught a trap in my own brief, and it would have cost a false accusation. I told it to read I already knew the Re-derived independently: all 28 distinct Both the commit message and the PR body were corrected to match the narrowed diff — three citations UNVERIFIED by it: the Sphinx warning-set rebuild, skipped within budget. Unpublished and awaiting you — I do not merge. |
Please follow the guide below
make pylint,make mypy,make isort) — prose only, no Python touchedmake testpasses, and a test case covers the change —tests/project/test_conventions_doc_claims.pyalready asserts on these pagesdocs/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?
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
Implements the #719 ruling under
docs/source/: a pull request describes a point in time, so citethe issue the work belonged to, or describe the change with no number at all.
Counts, derived against this base. 582
#NNNreferences underdocs/source/— 220 pullrequests, 358 issues, and 4 occurrences naming a GitHub discussion (#106, #251), which is neither.
188 of the 220 sit in
changelog/and 1 more inchangelog.rst, both exempt, leaving 31 actedon:
process.rst22,registry-protocol.rst5,extension-header-subclassing.rst2,mint-criterion.rst2. That bucket is now at zero pull-request references; its issue references rose72 → 87.
Changed.
process.rst—breaking's worked examples now cite #805, #759, #618, #806 and #778;the label census and the shared-changelog mentions are described rather than numbered, and the
commit-count command looks its pull request up by title.
registry-protocol.rst— #903, #808, #877;the two
mh.pyoverrides' widening and their later deletion were each ruled in a review threadrather than on an issue, so both read as prose.
extension-header-subclassing.rst— #917, the renamethe second-base ruling was given in review of, since no issue owns that ruling alone.
mint-criterion.rst— #841 ×2.Verified. 37 passed, 1 pre-existing skip. Sphinx against a
mainbaseline: 63 warning lineseach, 0 new, 0 gone, 7 duplicate-label and 0 orphan both sides, each build's
pcapkit.__file__printed to prove its tree. All 45 link targets are issues and every displayed
#NNNmatches its ownURL. Over-88 lines under
docs/source/contributing/went 23 → 22, none added.