Repository navigation
docs(contributing): record the tests/ and changelog PR-citation exemptions - #980
Conversation
de44ae3 to
bf331ee
Compare
|
GOOD TO GO at It re-derived every factual claim in the new exemption passage from the tree rather than from the Both blocking defects confirmed fixed. The orphaned demonstrative is gone — It also independently validated the "whole exempt set" claim rather than assuming it. It The note I am taking: the passage says the changelog and One thing worth recording about counts. Its totals disagree with every earlier derivation UNVERIFIED by it: whether "frequently lacks the fact" holds at scale; it sampled one supporting |
bf331ee to
5a6ca38
Compare
|
GOOD TO GO carries to I am carrying a verdict across a head change, which I normally refuse to do, so the reasoning Labelled |
5a6ca38 to
aca5e19
Compare
- Record that the changelog and tests/ are both exempt from "cite the
issue, not the PR" (owner's ruling), for related rather than identical
reasons: a changelog entry's number is its own pointer, and the
changelog is dense with pull-request citations by design, while under
tests/ a substantial share of the cited pull requests close no issue at
all (one credits a proposal to an external contributor and closes
nothing), with the cited fact often living only in the pull request's
own body or review thread. No bare count is stated for either claim:
four independent derivations of the changelog's own citation total
(184, 185, 187, 187) disagreed, which is exactly the kind of
unverifiable figure the page's own Accuracy section warns against.
State the rest of the directory as the standing mechanism rather than a
status: a sibling page that cites a pull request is unconverted, not a
third exemption, and the changelog and tests/ are the whole exempt set.
That mechanism has no shelf life regardless of whether the sibling
pages' own conversion is at 0%, 100%, or regresses later. Drop the
unpinned closing claim that every citation on this page is an issue,
since nothing tests it either.
- Replace the backward-pointing "That is why ... :hidden:" sentence with a
direct statement of the reason, so it no longer points into the
preceding grep code block.
- Give the heading-rename sweep an antecedent ("ran in two passes ... its
first ... the second pass") so "The first pass"/"the second pass" are no
longer dangling definite references.
- Rewrite "the method the changelog review settled" as "the reliable
method", describing what it does rather than citing whose review decided
it.
- Reflow the lines left under 88 columns by earlier edits, and the
paragraphs touched above, to the page's own 88-column wrap.
Verified: tests/project/test_conventions_doc_claims.py (37 passed, 1
skipped, 140 subtests); Sphinx build succeeded, 61 warnings, none naming
this page, no duplicate-label/orphan warnings, 601 HTML pages.
aca5e19 to
b53819a
Compare
|
GOOD TO GO at The clause removal is sound and the surviving sentence is true. It read every blob with It widened the check beyond what I asked and that is where the value was. Across all 186 It corrected my brief, and my check as worded would have failed. I told it to confirm the diff Both verified here. The right comparison was against the previously reviewed revision, not One observation it flagged rather than blocked on: now that the sibling conversion has landed, "a Mechanical: 310 lines, max width exactly 88, 0 over, 0 trailing whitespace; the three new lines 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.pyrun directly (the full suite OOMs and is never run)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?
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
Two blocking review findings on
docs/source/contributing/conventions/documentation.rst(the #719 ruling page), both already on
mainsince the page's initial merge — thiscorrects a merged page rather than fixing an unmerged one.
1. The "cite the issue, not the pull request" paragraph recorded the ruling without the
exemption the owner granted. A changelog number is the pointer a reader follows, and
tests/**is exempt for the same reason: 21 of its citations, across 12 pull requests,name one with no issue behind it at all, and the cited fact often lives only in the pull
request's own body or review thread. Both exemptions are now recorded together; the
sibling convention pages remain unconverted as of this change.
2. A sentence on why the root toctrees are
:hidden:pointed backward into agrepcode block instead of stating its own reason. Rewritten to state it directly.
Also fixed: two dangling "the first/second pass" references, an unfindable citation of
"the changelog review", and five lines left short of the page's own 88-column wrap.
Verified:
tests/project/test_conventions_doc_claims.py— 37 passed, 1 skipped, 140subtests. No line exceeds 88 columns. Prose only — no role or directive changed.