Repository navigation
docs(protocols): tighten the internet-layer prose and correct stale claims (#719) - #1036
Merged
Merged
Conversation
Owner
Author
|
Cross-review verdict on
Confirmed with real parses and probes:
|
…laims (#719) - Cut timed context (what a check "used to" do, issue and fix narratives) from docstrings and comments in ah, hip, hopopt, internet, ipv4, ipv6_ext, ipv6_opts, ipv6_route and ipx; design rationale kept. - ipv4: the field table named a DSCP split the parser never performs; it now lists the pre/del/thr/rel/ecn ToS fields, and the Data field names offset and protocol. EOOL/NOP cited RFC 719; it is RFC 791. - ipv6_ext: drop five stale file:line references and a non-existent PCAPNG.read_frame; cite the real warn-and-clip sites. - ah, ipx: fix table field names (sah.* -> ah.*, cksum -> chksum) and a wrong Returns type; hopopt/ipv6_opts/ipv4: Constructured typo. - ipv6_route: record src_ip/dst_ip in the __post_init__ overload as deliberate (#505). Docstrings and comments only; AST unchanged once docstrings are stripped.
JarryShaw
force-pushed
the
docs/719-protocols-internet-b
branch
from
October 5, 2026 18:24
1673a95 to
ed6bda0
Compare
Owner
Author
|
Cross-review verdict on
|
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.
tests/protocols/internet,tests/project,tests/test_docstring_contract.py); no code change, so no new test caseWhat is the purpose of your pull request?
docs— documentation onlyDescription
Internet-layer half B of the #719 prose sweep (
ah,hip,hopopt,internet,ipv4,ipv6_ext,ipv6_opts,ipv6_route,ipx). Cuts timed context, keeps rationale, and fixes prose that disagreed with the code:ipv4: the field table named a DSCP split the parser never performs; it now lists thetos.pre/del/thr/rel/ecnfields. EOOL/NOP cited RFC 719, now RFC 791.ipv6_ext: five stalefile:linereferences and a non-existentPCAPNG.read_framereplaced by the real warn-and-clip sites.ah/ipx: wrong table field names and a wrongReturnstype.ipv6_route: thesrc_ip/dst_ipoverload-only discrepancy is recorded as deliberate (IPv6_Route.__post_init__ documents src_ip/dst_ip, which exist only in an @overload stub #505).tests/test_docstring_contract.pyandtest_ah_unit.pypin them.AST equal to
origin/mainonce bare-string statements are stripped:Sphinx
-n, fresh dirs, branch vsorigin/main: 12 vs 12 warnings on these files, 0 new (whole log 1315 vs 1315 lines).