Repository navigation
docs(protocols): version directives and accurate prose for the internet layer (#1103) - #1760
Merged
Merged
Conversation
Owner
Author
|
Verdict: GOOD TO GO at
|
…et layer (#1103) Version directives, all 1.5.0: - versionchanged on IPv4, IPv6, HIP, HOPOPT, IPv6_Opts, IPv6_Route, IPv6_Frag, MH, IPX, AH and Internet, naming each breaking fix's issues. - versionadded on IPv6_Ext and the esp module; versionremoved for SolutionParameter.lifetime, RPL.cmpr_i/cmpr_e and the IPv6-Opts SMF_DPD test field. Accuracy: - Header tables name the info keys and fields the data models carry (IPv4, IPv6, IPv6-Opts, IPv6-Frag, AH, HIP); "Header Extension Length". - ip.rst no longer lists IPsec as an IP subclass; ipsec.rst drops an *args parameter the class does not take. - HIP's parameter table lists R1_Counter (128); the IPv4 TS and HIP ECHO_RESPONSE_UNSIGNED makers document overflow and opaque. - IP and IPv6 cite RFC 8200; AH links its defining module. Rendering: unresolved references retargeted (ESP, HIP, MH, SA), a role split across lines rejoined, and the pages gain the Internet.from_data, IPv6._import_next_layer, alias and jumbogram helper entries they cite. Refs #1103
Contributor
|
Coverage: 89.59% (unit tier, Python 3.15,
Per-file detail: the |
JarryShaw
force-pushed
the
docs/1103-internet
branch
from
October 15, 2026 17:10
c061e25 to
6f1c4ea
Compare
Owner
Author
|
Verdict: GOOD TO GO at |
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
You will be asked some questions, please read them carefully and answer honestly
Put an
xinto all the boxes [ ] relevant to your pull request (like that [x])Use Preview tab to see how your pull request will actually look like
Searched for similar pull requests
Followed the coding style (
make pylint,make mypy,make isort)make testpasses, and a test case covers the change. Narrow runs only, listed below.Added a changelog entry under
docs/source/changelog/and regeneratedCHANGELOG.md, if the change is user-visible: N/A — centralised in docs(changelog): shared 1.5.0 changelog — long-lived, merges last (#610, #616, #617, #618, #620) #657What is the purpose of your pull request?
Tick the commit type your subject line carries.
fix— corrects a defectfeat— adds a featureperf— changes performance, not behaviourrefactor— changes neither behaviour nor performancetest— tests onlydocs— documentation onlyci— workflows or build toolingrelease— bumps the version or rolls up a distributionchore— anything elseDescription
Part of #1103, the whole-repository prose sweep, for the
internetslice. It follows the #719 rules: prose only, accuracy first, no churn and no timed context.Version directives, all 1.5.0:
IPv6_Frag, MH, IPX, AH and Internet, naming each breaking fix's issues.
NotImplemented.esp placeholder, SolutionParameter.lifetime,
RPL.cmpr_i/cmpr_e and the IPv6-Opts SMF_DPD test field.
Accuracy:
(IPv4, IPv6, IPv6-Opts, IPv6-Frag, AH, HIP); "Header Extension Length".
*args parameter the class does not take.
ECHO_RESPONSE_UNSIGNED makers document overflow and opaque.
Rendering: unresolved references retargeted (ESP, HIP, MH, SA), a role
split across lines rejoined, and the pages gain the Internet.from_data,
IPv6._import_next_layer, alias and jumbogram helper entries they cite.
Checks:
.py: code is identical once docstrings are blanked.tests/projectand every test that reads the edited paths pass.Not covered here; a round-2 PR follows: hip.py, mh.py, the hip/hopopt/ipv6_opts/ipv4/mh/ipv6_option schemas, the rest of ipv4/ipv6_route/esp/hopopt, and pcapkit/protocols/data/internet/**.
Refs #1103