Repository navigation
docs(foundation): convert bare citations to the issue role in docstrings - #1002
Conversation
|
GOOD TO GO at
The strongest evidence came from the review rather than from the PR: Also confirmed independently: 18 distinct cited numbers, every one an issue and none a pull request — including the four with commit-style titles (#832, #833, #886, #923) that look like PRs and are not. Not yet ready to merge: 6 CheckRun legs still in flight, 0 failures so far. |
|
Ready to merge at Unpublished changes on my side: none. Yours to merge. |
Please follow the guide below
make testpasses, and a test case covers the change — docstring-only, so no test change, matching docs(corekit): convert bare citations to the issue role in corekit docstrings #1000What is the purpose of your pull request?
docs— documentation onlyDescription of your pull request and other information
Third tranche of #989. Converts bare
#NNNcitations underfoundation,utilities,toolkitanddumpkitto:issue:roles, continuing #1000'scorekitpass.Scope follows the ruling on #989: plain
#comments keep the bare form (GitHub's code view links them; reST roles would render literally), so only docstrings, other string literals and#:autodoc doc-comments convert.Tokenised by token kind, base
e8a60d153→ head:#:doc-comments#comments:issue:rolesissues/NNNhyperlinks33 roles from 32 bare sites plus the one explicit hyperlink in
utilities/decorators.py. All 18 distinct numbers resolve to issues, not pull requests, so:issue:is correct at every site.DictDumper#125indumpkit/common.pyis left alone — it cites another repository.Rendered text is unchanged: the
:issue:caption is#%s. Docs build stays at 61 warnings, same WARNING/ERROR lines, including the two pre-existing docutils errors.