Skip to content

docs(protocols): third whole-repo pass over internet (#1103) - #1836

Merged
JarryShaw merged 1 commit into
mainfrom
docs/1103c-internet
Oct 16, 2026
Merged

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

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

Please follow the guide below

What is the purpose of your pull request?

Tick the commit type your subject line carries.

  • fix — corrects a defect
  • feat — adds a feature
  • perf — changes performance, not behaviour
  • refactor — changes neither behaviour nor performance
  • test — tests only
  • docs — documentation only
  • ci — workflows or build tooling
  • release — bumps the version or rolls up a distribution
  • chore — anything else

Directives

  • versionchanged on the AH, IPv4, IPv6, IPv6-Frag, IPv6-Route, IPX, MH
    and HIP make() signatures that insert a defaulted parameter ahead of
    existing positional ones.
  • OrderedMultiDict to OrderedMultiInfo on the HOPOPT, IPv6-Opts, HIP,
    IPv4, MH message and CGA data models and on TSOption.timestamp; the
    MPL seed_id, PUZZLE lifetime and BRA interval types; the schema
    trailer fields and the reserved fields now read as integers.

Counts

  • Drop counted subclasses, call sites, registry entries, subtypes and
    list items from the internet docstrings and pages.

Rendering

  • Fix the IPv6-Ext table continuation and class heading, the
    positional-arguments sections, the selector Returns lead-ins, the
    attribute comments autodoc split as types, stray rtype lines and an
    unresolved private-helper reference.

Accuracy

  • Correct the IPv6-Ext make() note, the HIP length checks, the IPX
    socket field, the options-length notes and the table name cells.

Non-prose check: ast.dump is unchanged on every .py file once docstrings are blanked. The versionchanged on each make() is checked against v1.4.1: every one of those signatures moves an existing positional parameter. Narrow test runs are green.

Refs #1103

Directives
- versionchanged on the AH, IPv4, IPv6, IPv6-Frag, IPv6-Route, IPX, MH
  and HIP make() signatures that insert a defaulted parameter ahead of
  existing positional ones.
- OrderedMultiDict to OrderedMultiInfo on the HOPOPT, IPv6-Opts, HIP,
  IPv4, MH message and CGA data models and on TSOption.timestamp; the
  MPL seed_id, PUZZLE lifetime and BRA interval types; the schema
  trailer fields and the reserved fields now read as integers.

Counts
- Drop counted subclasses, call sites, registry entries, subtypes and
  list items from the internet docstrings and pages.

Rendering
- Fix the IPv6-Ext table continuation and class heading, the
  positional-arguments sections, the selector Returns lead-ins, the
  attribute comments autodoc split as types, stray rtype lines and an
  unresolved private-helper reference.

Accuracy
- Correct the IPv6-Ext make() note, the HIP length checks, the IPX
  socket field, the options-length notes and the table name cells.

Refs #1103
@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 16, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 16, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Verdict: GOOD TO GO at 6aa3f9b99. A Sonnet cross-review (author: Opus) checked:

  • every make() directive against v1.4.1 with ast: each names exactly the inserted parameters, and the cited issues match;
  • the type-change directives, by running parses: HOPOPT now gives OrderedMultiInfo, and the MPL type-0 seed_id is None on 1.4.1 but an IPv6Address at the head. It also checked the PUZZLE lifetime, BRA interval, the schema reserved fields and the trailer fields;
  • the HIP "not a multiple of N" checks against the code, and the IPX socket and IPv6-Ext make() note;
  • the table fixes, with docutils.

No count was added, and the ASTs are identical with docstrings blanked. A combined clean Sphinx build of main with this branch adds no warnings.

Its first line read NEEDS CHANGES, but it listed no required change. The flagged items are polish and are held for the next pass:

  • :no-value: on CIPHER_SUITES/INTEGRITY_SUITES hides per-suite figures (e.g. salt_length) that the tables only partly carry;
  • mh.py "every other subtype" now also covers NAI;
  • the module-docstring tables in ipv4.py, esp.py and ipv6_ext.py:48-59 keep defects the .rst copies fixed.

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

Copy link
Copy Markdown
Contributor

Coverage: 90.05% (unit tier, Python 3.15, 6aa3f9b99, Unit Tests run success)

Package Statements Missed Branches Partial Cover
pcapkit (top level) 104 2 20 2 96.77%
pcapkit/const 19595 881 2618 867 92.11%
pcapkit/corekit 2462 69 780 35 96.55%
pcapkit/dumpkit 276 3 100 3 98.40%
pcapkit/foundation 2915 164 1016 34 93.59%
pcapkit/interface 138 7 52 5 93.68%
pcapkit/protocols 17408 224 4580 189 98.10%
pcapkit/toolkit 872 177 298 8 77.18%
pcapkit/utilities 512 2 158 4 99.10%
pcapkit/vendor 4407 2342 1010 157 43.27%

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

@JarryShaw
JarryShaw merged commit 2ad8dec into main Oct 16, 2026
60 checks passed
@JarryShaw
JarryShaw deleted the docs/1103c-internet branch October 16, 2026 23:11
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 16, 2026
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 16, 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