Repository navigation
docs(protocols): second-round pass over the protocol pages (#719) - #1086
Merged
Merged
Conversation
Owner
Author
|
Cross-review verdict on
Everything else checks out:
UNVERIFIED: no Sphinx build. |
- ftp, rarp, arp, ngap, esp, protocol: drop "contains X only" where the module defines more (FTP_DATA, DRARP, InARP, the NGAP enums, the ESP SA/algorithm types, ProtocolBase/ProtocolMeta); protocol.rst now says to inherit Protocol directly only for a new protocol stack, a layer base otherwise, and that the built-in families derive from ProtocolBase - ipx: the checksum field is ipx.chksum, not ipx.cksum - mh: drop the stale todo; the CGA Parameters option (type 12) is registered to _read_opt_cga_param/_make_opt_cga_param - index: add NGAP to the class-hierarchy graph and group the click targets of the application-layer classes together - application/index: fix the APPTYPE alias target to pcapkit.const.reg.apptype.apptype.AppType (was unresolved) - misc/index: name PCAPNG alongside the PCAP header classes - c_tag, s_tag: list id() among the identity members each tag adds sphinx -b dummy -n: 1 -> 0 warnings on these pages, none new; tests/project passes.
JarryShaw
force-pushed
the
docs/719r2-protocols
branch
from
October 6, 2026 17:38
8e79637 to
a34eea9
Compare
Owner
Author
|
Cross-review verdict on The delta from
Not re-run for this prose-only delta: tests and Sphinx. The worker reports Sphinx |
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
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.
make pylint,make mypy,make isort) — N/A, docs-only (Sphinx -n and tests/project below)make testpasses, and a test case covers the change —tests/projectpasses; prose onlyWhat is the purpose of your pull request?
docs— documentation onlyDescription of your pull request and other information
Second-round #719 read of all 46 pages under
docs/source/pcapkit/protocols/; 13 changed, 33 left as they were. Every fix is a claim the code contradicts:ftp,rarp,arp,ngap,espandprotocol(checked against each module's__all__).protocol.rstalso calledProtocolthe base of every family, but the built-in families subclassProtocolBase.ipx: the field isipx.chksum.mh: removed the todo saying CGA Parameters (type 12) still used the generic handler, sinceMH.__option__routes it tocga_param.index: NGAP was missing from the class-hierarchy graph.application/index: theAPPTYPEalias target was unresolved; it now points topcapkit.const.reg.apptype.apptype.AppType.misc/indexnow names PCAPNG, andc_tag/s_tagnow includeid()in the identity members they add.sphinx -b dummy -non fresh output directories, counting warnings on these pages only: main 1, branch 0, none new.