Repository navigation
docs(protocols): second-round pass over the internet-layer prose (#719) - #1081
Merged
Merged
Conversation
Contributor
|
Coverage: 88.74% (unit tier, Python 3.14,
Per-file detail: the |
- registry attribute comments (IPv4, HOPOPT, IPv6-Opts, IPv6-Route, HIP, MH x3): a non-string value is a (parser, constructor) pair, and a missing named method falls back to the unassigned/none handler - HOPOPT/IPv6-Opts Raises: name the field the code checks (schema.len), fix the copy-pasted tun/jumbo names, and say what the length check is - HIP: _read_locator returns IPv6Address/LocatorData; PUZZLE and SOLUTION raise on a HIPv1 length mismatch, not on any non-v1 version - IPv6-Opts make documents Destination, not Hop-by-Hop, options - "Header Extensive Length" -> "Header Extension Length"; split :class: role rejoined; shorter IPv6 walk comment; past-tense rationale restated in the present (IPv6-Route, IPv6-Opts, MH) Docstrings and comments only; AST-identical to origin/main.
JarryShaw
force-pushed
the
docs/719-r2-internet
branch
from
October 6, 2026 17:09
4938f5c to
3f7ba46
Compare
Owner
Author
|
Cross-review verdict on Round 1 (
AST guard: all 7 files are identical to UNVERIFIED: the 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.
Please follow the guide below
make testpasses, and a test case covers the changeWhat is the purpose of your pull request?
docs— documentation onlyDescription of your pull request and other information
Second-round #719 read of all 16 files under
pcapkit/protocols/internet/; 7 changed, 9 left as they were. Every change corrects a claim the code contradicts, or past-tense rationale:strvalue is a(parser, constructor)pair, and a missing named method falls back to theunassigned/none/unknownhandler. The old text said the value "should be a method".Raises:: nameschema.len, which is what the code checks. Router Alert saidtunand Home Address saidjumbo. The threshold line now states the!=check._read_locatorreturnsIPv6Address/LocatorData, notIPv4Address/Locator. PUZZLE and SOLUTION raise when the length is wrong under HIPv1. The docs said they raise on any non-v1 version.maketakes Destination Options, not Hop-by-Hop. "Header Extensive Length" now reads "Header Extension Length". A:class:role that was split across two lines is joined again, which removes one Sphinx-nwarning. The IPv6 walk comment is shorter, and its "check above" now reads "this check". That comment still names Shim6 as the code with no dedicated parser that resolves toIPv6_Ext. MH'sintervalis documented as unused whenoptionis given.Tests: each
tests/protocols/internet/test_*.pywas run in its own process, plustests/test_docstring_contract.pyandtests/project. All pass. Sphinx-n, fresh builds, this slice only: 35 warnings on the branch against 36 on main, none new.origin/main(docstrings stripped)hip.pyhopopt.pyipv4.pyipv6.pyipv6_opts.pyipv6_route.pymh.py