Skip to content

chore: cite issues as #NNN in plain comments - #1982

Merged
JarryShaw merged 1 commit into
mainfrom
chore/issue-refs-in-comments
Oct 20, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
chore/issue-refs-in-comments

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

What is the purpose of your pull request?

  • chore — tooling or repository hygiene

Description of your pull request and other information

Plain # comments now cite issues as #NNN. The :issue:`NNN` / :pr:`NNN` roles stay only where Sphinx renders them: docstrings, #: attribute comments and .rst.

  • Plain comments are converted across pcapkit/, docs/source/conf.py and tests/. The citations were found by tokenising every tracked .py file, so docstrings are left untouched. The diff changes no code tokens.
  • The new tests/project/test_issue_refs_in_comments.py fails on any plain comment that uses the roles. A short allowlist covers comments that talk about the role rather than cite an issue. It fails on main and passes here.

Plain # comments are never rendered by Sphinx, so the :issue: role there is
noise around the number. Convert every plain comment (not docstrings, not #:
doc-comments) to #NNN, and add tests/project/test_issue_refs_in_comments.py,
which tokenises every tracked .py file and fails on a role in a plain
comment, bar three comments that talk about the roles themselves.
@JarryShaw JarryShaw added chore Maintenance work: tooling, repo hygiene, no library behaviour change review: running A cross-review is in flight against the current head - no verdict yet labels Oct 20, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 20, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

GOOD TO GO at d4e1d4f38. A Sonnet review found:

@JarryShaw JarryShaw added review: good-to-go Cross-review at the current head says ready; CI state is separate and removed review: running A cross-review is in flight against the current head - no verdict yet labels Oct 20, 2026
@JarryShaw
JarryShaw merged commit ca6ebb5 into main Oct 20, 2026
55 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 20, 2026
@JarryShaw
JarryShaw deleted the chore/issue-refs-in-comments branch October 20, 2026 15:50
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 20, 2026
@JarryShaw JarryShaw added this to the PyPCAPKit v1.5 milestone Oct 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Maintenance work: tooling, repo hygiene, no library behaviour change

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant