Skip to content

docs(protocols): fifth whole-repo pass over internet (#1103) - #2155

Merged
JarryShaw merged 1 commit into
mainfrom
docs/1103-r5-internet
Oct 25, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
docs/1103-r5-internet

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

What is the purpose of your pull request?

  • docs — documentation only

Description

Part of #1103, round 5: the internet slice, against main 4c3d30163. This changes prose only: with docstrings stripped, the AST of all 12 changed .py files is identical.

- register_* docs: describe ``meth`` as a method-name suffix or a
  (parser, constructor) pair, matching the registry dispatch
- Internet ``__proto__`` table: add the missing Shim6 row
- HIP/HOPOPT/IPv6-Opts/MH field comments: fix SPI, Update ID,
  Destination HITs, PDM and Seed-ID wording; document Locator lifetime
- HOPOPT/IPv6-Opts ``_make_*_options``: OrderedMultiInfo, not
  OrderedMultiDict (#1484)
- MH: reversed-namespace flags, IGMP selector protocol values
- IPv6-Route: name the inverse of ipv6_route_header_length
- rst: add missing alias/protocol, _exthdr_rebuilt and
  ipv6_route_header_length directives

Prose only; AST identical with docstrings stripped.
@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 25, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 25, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

GOOD TO GO at 2cf6a3e10 (Sonnet review, with the RFC texts fetched to check against).

  • meth: every _read_*/_make_* site uses the string as a suffix and indexes anything else [0]/[1]. Each cited registry is documented on its page.
  • Shim6: Internet.__proto__[Shim6] = IPv6_Ext is set in ipv6_ext, so the new table row is right.
  • HOPOPT: OrderedMultiInfo matches refactor(corekit)!: Info.to_dict() returns an OrderedMultiDict; add MultiInfo and OrderedMultiInfo to infoclass #1484.
  • HIP fields:
    • OLD/NEW SPI (RFC 7402 §5.1.1)
    • Update ID (RFC 7401)
    • Host Identity Tags in ROUTE_DST (RFC 6028)
    • FROM Address (RFC 8004)
    • Locator Lifetime in seconds (RFC 8046)
  • HOPOPT/IPv6-Opts:
    • PDM is the name RFC 8250 uses.
    • The MPL S field is the Seed-ID length (RFC 7731 §6.1).
  • MH:
    • *_reversed feeds reversed= of the namespace lookup.
    • The IGMP values are 0x12, 0x16 and 0x22 (RFC 7028 §8).
    • "Most flags" is right.
  • IPv6-Route: the inverse cited for ipv6_route_header_length is right.
  • Checks: the new doc entries import and appear once each. The AST guard is OK on all 12 files. tests/project/test_docs_* plus the conventions test: 94 passed. tests/protocols/internet plus the docstring contract: 518 passed.
  • UNVERIFIED: whether the new cross-references resolve in a pinned Sphinx build.

@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 25, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Coverage: 91.55% (unit tier, Python 3.15, 2cf6a3e10, Unit Tests run success)

Package Statements Missed Branches Partial Cover
pcapkit (top level) 104 4 20 2 95.16%
pcapkit/const 19599 880 2618 866 92.12%
pcapkit/corekit 2589 75 816 37 96.48%
pcapkit/dumpkit 282 3 102 3 98.44%
pcapkit/foundation 2971 23 1036 25 98.80%
pcapkit/interface 138 4 52 3 96.32%
pcapkit/protocols 17418 219 4574 185 98.14%
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

Copy link
Copy Markdown
Owner Author

Ready to merge at 2cf6a3e10.

  • Review: Sonnet GOOD TO GO, checked against the RFC texts.
  • CI: all 61 CheckRuns passed, none failed or pending. Required checks passed is SUCCESS, and the KTLO legs raised no warnings.
  • Ordering: I merged this PR into main and ran tests/project plus the root modules under the plain unittest ordering leg: 2288 tests, 0 failures, 0 errors.
  • Merge conflicts: none with the other round-5 PRs.

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

Labels

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

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant