docs(tests): stop calling pull requests issues in the const suites - #999
Conversation
Part of #719. 16 sentences under tests/const/ described a pull request as a "GitHub issue". tests/ is exempt from the rule preferring the issue over the pull request (conventions/documentation.rst:203), but no exemption makes calling a pull request an issue true. All 18 changed lines are in-place replacements; nothing is reflowed, so no marker or inline literal could move. Max width, the count of lines over 95 and the reStructuredText marker count are byte-identical per file. Two of the sixteen were false twice over, not merely mislabelled. - builtin_parity:1138 said #803 added a test. It did not: git log -S finds the def first appearing in fc32d1b, whose subject is PR #677's squash merge. #803's own commit carries that def only as diff context and adds two other tests. Relabelled to PR #677. - Six sites credited "#775/#847's ruling" with converting or not touching mint sites. #847 closes #841, not #775, and it converted nothing -- it reordered Socket._missing_ range branches. Neither "PR #847 converted" nor "#775/#841" would be true, because the criterion is not in #841's text either: conventions/mint-criterion.rst:52-56 records it as settled in review of #841's branch-order fix and reaffirmed on #775, so it lives in #847's review thread. The false noun is dropped and the bare pair kept, matching six siblings already written that way in this directory and no_mint:28's "settled on PR #847 and confirmed on #775". Eight further candidates were left alone because they already label the pull request correctly -- "fixed by #865", "blocked on #859", "the PR #836 ruling" and similar. A scan keyed on the citation run the phrase actually governs, rather than any number nearby, is what separates them. No test pin needed changing: no assertion anywhere in tests/ quotes a string this touches. The seven changed files pass: 244 passed, 40001 subtests, exit code 0 read from the process.
|
GOOD TO GO at The description said "#847 closes #841" and GitHub parsed that as a closing keyword. This pull request was listed under The contestable call holds. I asked the review to attack the #847 decision hardest, and it independently confirmed each limb: #847 closes #841 and reordered The count that matters is confirmed by a different method. It typed all distinct numbers cited in It also checked the #677 relabel at the level that matters — not just that #677 is the right number, but that the claim is true of it: Four of the eight left-alone candidates spot-checked, all genuinely already correct. No collateral damage: 18 insertions and 18 deletions, identical line counts, max widths, over-95 counts and markup-character counts per file, the pre-existing role split at Label is now |
|
Correction to the comment above: my first fix did not work, and I said it had. I wrote that the stray closing reference was gone. It was not — it survived, because I replaced "closes #841" with "fixed #841", and The sentence now avoids the construction entirely — "#841 is the issue #847 landed against" — and a scan of the whole description for Worth recording because the trap is broader than the one word: GitHub's closing keywords are a set, not a word, so removing one and leaving another in the same sentence changes nothing, and the only way to know is to re-query the reference after editing. Nothing about the diff changed; this was description prose throughout. |
|
Ready to merge at One commit on Unpublished decisions are yours, and I have not merged. This and #998 are both ready and independent of each other — #998 touches Still queued behind #998 specifically: the |
Please follow the guide below
make pylint,make mypy,make isort)make testpasses, and a test case covers the changedocs/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 elsePart of #719.
Description of your pull request and other information
16 sentences under
tests/const/described a pull request as a "GitHub issue".tests/is exempt from the rule preferring the issue over the pull request (conventions/documentation.rst:203) — but no exemption makes calling a pull request an issue true, and that is the whole of this change.All 18 changed lines are in-place replacements. Nothing is reflowed, so the marker-merge and inline-literal-split hazards are structurally absent rather than merely checked for; max width, the count of lines over 95 and the reStructuredText marker count are byte-identical per file.
Two of the sixteen were false twice over, not merely mislabelled.
test_const_enum_builtin_parity.py:1138said #803 added a test. It did not.git log -Son thatdeffinds it first infc32d1b81, whose subject is PR #677's squash merge; #803's own commit carries the line only as diff context and adds two different tests. Relabelled toPR #677.Six sites credited "#775/#847's ruling" with converting or sparing mint sites. #841 is the issue #847 landed against, not #775, and it converted nothing — it reordered
Socket._missing_range branches. SoPR #847 converted…would restate the same false claim in correct grammar, and#775/#841fails differently, because the criterion is not in #841's text either:conventions/mint-criterion.rst:52-56records it as settled in review of #841's branch-order fix and reaffirmed on #775, which puts it in #847's review thread — exactly the case thetests/exemption exists for. The false noun is dropped and the bare pair kept, matching six siblings already written that way in this directory andtest_const_enum_no_mint.py:28's "settled on PR #847 and confirmed on #775".Eight further candidates were left alone because they already label the pull request correctly — "GitHub issue #862, fixed by #865", "blocked on #859", "the PR #836 ruling" and similar. Separating them needs a scan keyed on the citation run the phrase actually governs, not on any number appearing nearby; the looser method reports 24 sites where 16 are real.
No test pin needed changing — no assertion anywhere in
tests/quotes a string this touches. The seven changed files pass: 244 passed, 40001 subtests, exit code 0 read from the process.One site outside this tranche, for whoever takes it:
tests/foundation/registry/test_protocols.py:535calls PR #815 an issue.