Repository navigation
docs(internet): convert bare citations to the issue role in docstrings - #1003
Conversation
…docstrings (#989) - Replace bare `#NNN` citations in docstrings and `#:` doc-comments under `pcapkit/protocols/internet/` and `pcapkit/protocols/protocol.py` with `:issue:` roles; plain `#` comments keep the bare form per the #989 ruling. - Leave the 36 RFC packet-diagram labels (`DH GROUP ID #1` and the like) in `hip.py` untouched. Docs build: 61 warnings / 2 errors before and after. tests/protocols/internet and tests/test_docstring_contract.py pass.
|
GOOD TO GO at
Independently confirmed beyond that: all 36 surviving one-digit citations sit inside One thing worth knowing for the rest of #989: two Not ready to merge yet — CI still finishing, 0 failures so far. |
|
Ready to merge at 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
Fourth tranche of #989, alongside #1002. Converts bare
#NNNcitations underpcapkit/protocols/internet/andpcapkit/protocols/protocol.pyto:issue:roles, continuing #1000'scorekitpass.Scope follows the ruling on #989: plain
#comments keep the bare form, so only docstrings and#:autodoc doc-comments convert.Tokenised by token kind, base
e8a60d153→ head:#:doc-comments#comments:issue:rolesThe 36 survivors are RFC packet-diagram labels, not citations —
DH GROUP ID #1,HIT #1,Suite ID #2and the like, all inhip.py. Every one is a single digit, and no 3-or-more-digit bare citation survives, so nothing real was skipped on that boundary.84 roles across 25 distinct numbers, every one an issue rather than a pull request. 79 of the 84 sit inside docstrings (
ast-checked); the other 5 are the#:doc-comments, whichastcannot see. None is a runtime string, so no message text changed, and the#%scaption leaves the rendered text identical. Docs build stays at 61 warnings and the two pre-existing docutils errors.