docs(corekit): convert bare citations to the issue role in corekit docstrings - #1000
Conversation
…cstrings Applies the roles added in #998 across `pcapkit/corekit/`, so the citations in these modules resolve to links in the rendered docs instead of staying inert text. - 100 conversions across 8 modules, all inside docstrings and `#:` attribute doc comments -- the two places autodoc parses as reStructuredText. - Plain `#` comments are deliberately left as bare `#NNN`, per the ruling on #989: GitHub's code-tree view links them, and a role there would render as neither a link on GitHub nor a reference in Sphinx. 11 such citations in these files stay untouched. Sphinx builds clean (exit 0, no unknown-role errors, 61 warnings / 2 errors -- unchanged from the baseline); `tests/corekit` 400 passed, 16 skipped, 0 failed.
|
GOOD TO GO at Correction to the description above, which the review caught and I verified by tokenising both Per-claim, with the measurement it made itself:
One honest limit it reported rather than papering over: it did not re-check carried-over phrases such CI at |
|
CI note: No test failed anywhere. The cancelled job completed steps 1-5 green and died inside What makes it a runner anomaly rather than a 3.12 problem: on the same commit, Re-ran the failed jobs only; attempt 2 is in flight. The |
|
Ready to merge at Current state at this head: That 16m52s is the useful evidence for the earlier diagnosis: the same commit, the same step, the same Cross-review verdict GOOD TO GO stands at this head, and nothing has been pushed since — so the |
Description
Applies the citation roles added in #998 across
pcapkit/corekit/— 100 roles in 8 modules, allinside docstrings and
#:attribute doc comments, the two places autodoc parses as reStructuredText.Measured base → head by tokenising both commits: 99 bare
#NNNcitations converted, plus oneexplicit hyperlink in
enum.py(#930written out as a full URL) that became:issue:930``.Rendered text is unchanged in both cases, since the caption is
#%s. Held until #998 landed, because a converted docstring built against a tree withoutthe roles errors on an unknown role.
Plain
#comments keep the bare#NNNform, per the ruling on #989: GitHub's code-tree view linksthem, and a role there would render as neither a link on GitHub nor a reference in Sphinx. 11 such
citations in these files are deliberately untouched.
Verification
sphinx -b htmlexit 0, 0 unknown interpreted text role errors, 61 warnings / 2 errors —unchanged from the pre-existing baseline.
tests/corekit— 400 passed, 16 skipped, 658 subtests, 0 failed.worktrees and confirmed no plain comment was converted and no
#:comment or docstring was missed.Checklist