Skip to content

docs(internet): seventh whole-repo pass over the internet protocols (#1103) - #2259

Merged
JarryShaw merged 1 commit into
mainfrom
docs/1103-r7-internet
Oct 26, 2026
Merged

docs(internet): seventh whole-repo pass over the internet protocols (#1103)#2259
JarryShaw merged 1 commit into
mainfrom
docs/1103-r7-internet

Conversation

@JarryShaw

@JarryShaw JarryShaw commented Oct 26, 2026 •
edited
Loading

Copy link
Copy Markdown
Owner

What is the purpose of your pull request?

  • docs — documentation only

Description

Part of #1103, round 7. A full read of the internet protocols: every module, data model, schema and API page. Prose only; the AST guard (docstrings stripped) is identical on all 21 .py files.

  • MH: _mh_option_length names all its exceptions; HAck codes include 131/132 (RFC 5949 IANA section).
  • HIP:
    • Parameter.length is the whole record.
    • ESP_INFO reserved drops the "zero when sent" quote attributed to RFC 7402 §5.1.1, which defines no such text (it is §5.1.2's).
    • PUZZLE lifetime is defined in RFC 5201 too.
    • LOCATOR_SET padding and locator lengths are corrected.
    • CERT cites RFC 8002.
    • FROM/RELAY_FROM/RELAY_TO meanings are corrected.
  • HOPOPT/IPv6-Opts: SMF_DPD cites RFC 6621 §6.1.1; CALIPSO cmpt_len is in octets, SMF tid_len is the raw field; MPL names RFC 7731.
  • IPv4/ESP: TFC padding is RFC 4303 §2.7 (also in esp.rst); ESP.make/IPv4.read/_make_opt_ts Raises; field units.
  • IPv6_Ext/IPv6_Route: Next Header placement cites RFC 8200 §4 and ESP's trailer; guard, alias and keyword-allowlist notes match the code (also in ipv6_ext.rst).
  • Tests: tests/protocols/internet/ 519 passed; docs and convention tests pass; no text pins on changed phrases.

Code-level findings from this pass are filed separately.

@JarryShaw
docs(internet): seventh whole-repo pass over the internet protocols (#…
7cbd334 
…1103)

Full read of every internet module, data model, schema and API page.

- MH: _mh_option_length names every exception; HAck codes include 131/132.
- HIP: Parameter.length, ESP_INFO reserved attribution, PUZZLE per RFC 5201
  too, LOCATOR_SET padding, CERT cites RFC 8002, FROM/RELAY_* meanings.
- HOPOPT/IPv6-Opts: SMF_DPD cites RFC 6621 section 6.1.1; CALIPSO and SMF
  units; MPL names RFC 7731; Raises/Warns sections.
- IPv4/ESP: TFC padding is RFC 4303 section 2.7; Raises sections; units.
- IPv6_Ext/IPv6_Route: Next Header placement per RFC 8200 section 4 (ESP's
  trailer); guard, alias and keyword-allowlist notes; Raises sections.
- esp.rst and ipv6_ext.rst follow the corrected docstrings.
@JarryShaw JarryShaw added this to the PyPCAPKit v1.5 milestone Oct 26, 2026
@JarryShaw JarryShaw added docs Pull requests that change documentation only (docs: subject prefix) review: running A cross-review is in flight against the current head - no verdict yet labels Oct 26, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 26, 2026
@JarryShaw

JarryShaw commented Oct 26, 2026

Copy link
Copy Markdown
Owner Author

Review: GOOD TO GO at 7cbd33440 (Sonnet).

  • Prose only: the AST guard with docstrings stripped is identical on all 21 .py files.
  • Claims: each claim checked against RFC text from rfc-editor.org and the code holds: RFC 4303 §2.7, RFC 6621 §6.1.1, RFC 5949 131/132, RFC 7402 §5.1.1, RFC 5201 §5.2.4, RFC 8002 §2, RFC 8200 §4, _mh_option_length, CALIPSO cmpt_len, IPv6_Ext.protocol guards, _declared_keywords, IPv6_Route.make dst.
  • Tests: tests/protocols/internet, the docstring contract, the conventions and the docs tests give 636 passed. No text pins on changed phrases.
  • Follow-up applied: the body's ESP_INFO line now matches the diff.

@JarryShaw JarryShaw added review: good-to-go Cross-review at the current head says ready; CI state is separate and removed review: running A cross-review is in flight against the current head - no verdict yet labels Oct 26, 2026
@github-actions

github-actions Bot commented Oct 26, 2026

Copy link
Copy Markdown
Contributor

Coverage: 91.56% (unit tier, Python 3.15, 7cbd33440, Unit Tests run success)

Package Statements Missed Branches Partial Cover
pcapkit (top level) 104 4 20 2 95.16%
pcapkit/const 19599 881 2618 867 92.11%
pcapkit/corekit 2589 74 816 37 96.51%
pcapkit/dumpkit 282 3 102 3 98.44%
pcapkit/foundation 3023 23 1044 25 98.82%
pcapkit/interface 138 4 52 3 96.32%
pcapkit/protocols 17437 218 4586 185 98.15%
pcapkit/toolkit 869 36 298 10 95.20%
pcapkit/utilities 504 7 146 5 98.15%
pcapkit/vendor 4432 1988 1018 167 51.87%

Per-file detail: the coverage-html artifact of this run.

@JarryShaw

JarryShaw commented Oct 26, 2026

Copy link
Copy Markdown
Owner Author

Ready to merge at 7cbd33440. Part of #1103, round 7: the internet slice.

  • Review: Sonnet GOOD TO GO.
  • CI: all checks complete, Required checks passed SUCCESS, 0 failed. The experimental legs are green.
  • KTLO: 12 legs, no warnings.
  • Ordering: merged into main and run. protocols leg: 1942 tests, 0 failures.
  • Conflicts: none against the current main.

@JarryShaw
JarryShaw merged commit 2d8c8b5 into main Oct 26, 2026
67 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 26, 2026
@JarryShaw
JarryShaw deleted the docs/1103-r7-internet branch October 26, 2026 20:26
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

docs Pull requests that change documentation only (docs: subject prefix)

Projects

PyPCAPKit
Status: Done

Milestone

PyPCAPKit v1.5

Development

Successfully merging this pull request may close these issues.

1 participant

@JarryShaw