Repository navigation
Fix typo in README - #1
Merged
Merged
Conversation
Copilot AI
added a commit
that referenced
this pull request
Aug 13, 2026
Co-authored-by: JarryShaw <15666417+JarryShaw@users.noreply.github.com>
This was referenced Sep 17, 2026
JarryShaw
added
the
docs
This was referenced Sep 29, 2026
JarryShaw
added a commit
that referenced
this pull request
Oct 2, 2026
…the conventions pages Closes nothing yet; the first tranche of #989. A bare ``#NNN`` renders as literal text, so every tracker citation in the built documentation is unclickable. The roles are deliberately opt-in per site rather than an automatic ``#NNN`` rule, because no digit-keyed pattern separates a citation from a packet-diagram label. ``#\d{3}`` already misses 17 two-digit citations that are real, and ``#\d+`` would catch the 45 one-digit RFC diagram labels in pcapkit/protocols/internet/hip.py and pcapkit/protocols/transport/sctp.py (``DH GROUP ID #1``, ``Gap Ack Block #1``), which reference nothing. A role nobody writes cannot corrupt them. ``:issue:`` and ``:pr:`` both caption ``#%s``, so converting a bare citation or an explicit link changes the markup and not the rendered text. Six sites were inline literals and are the exception: ``#934``, ``#949`` and ``#911`` in documentation.rst and ``#759``, ``#805`` and ``#775`` in process.rst rendered as monospace and now render as links in body font. They are separate roles because the issue-versus-pull-request distinction is itself a documented convention and one role would flatten it in the source. ``:discussion:`` exists because the repository has five GitHub Discussions -- 105, 106, 127, 251 and 274 -- for which the issues API returns 404, so ``:issue:`` would render a dead link. Scope, measured rather than taken from the issue: 895 bare citations sit on the surface Sphinx actually renders, which is docs/**/*.rst plus pcapkit/ docstrings and ``#:`` comments. All 1,580 autodoc directives target pcapkit.* and there is no literalinclude, so tests/, util/ and examples/ never reach a page and their citations cannot fail to resolve. 420 of the 895 are actionable; the other 475 are under docs/source/changelog, which #657 owns and util/changelog_md.py generates. This tranche converts 78 sites across the seven conventions pages -- 45 explicit links collapsed, 6 inline literals, 27 bare. All 33 distinct numbers were resolved in one GraphQL issueOrPullRequest call and every one is an issue, so :issue: is correct at each site; the collapsed links asserted label == URL number, so every rendered URL is byte-identical to before. Two tests pinned the bare ``#NNN`` source form and this change reddens both. test_conventions_doc_claims.py's floor now counts explicit links and role citations together, keeping the pairwise label-versus-URL comparison over whatever explicit links remain. test_sentinel_exports_unit.py accepts the citation in either markup form. Both were checked against the old page, where the pre-change assertions fail, so neither is vacuous. Verified: Sphinx 9.1.0 builds with exit code 0, the documented root printed and confirmed inside the worktree, 78 rendered /issues/NNN anchors matching the 78 conversions, and no warning naming any conventions page. tests/project/ gives 258 passed, 1 skipped, 859 subtests; the page-reading corekit tests give 61 passed, 129 subtests. All exit codes read from the process. The conf.py comment also had three inaccuracies of its own, which a change about citation accuracy should not ship: it named two files for the 45 one-digit diagram labels where they live in three (internet/hip.py 36, transport/sctp.py 7, schema/internet/hip.py 2); it said ``#\d{3}`` misses four-digit numbers "now arriving" when there are none yet, and omitted the 17 two-digit ones it does miss; and it claimed rendering was unchanged without the inline-literal exception. The Sphinx build is unchanged against main: 61 warnings and 2 errors on both, no warning or error naming any conventions page, and no warning kind new to the branch. Both errors are pre-existing, in pcapkit/corekit/infoclass.py and pcapkit/protocols/schema/schema.py docstrings, neither of which this change touches.
Merged
4 of 12 tasks
This was referenced Oct 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.