Skip to content

docs(protocols): second pass over application, misc and the protocol base (#1103) - #1785

Merged
JarryShaw merged 2 commits into
mainfrom
docs/1103-application-r2
Oct 15, 2026
Merged

JarryShaw merged 2 commits into
mainfrom
docs/1103-application-r2

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

Summary

#1103 round 2: the files phase 1 left unread, plus the phase-1 reviewers' follow-ups.

protocol.rst:

  • give ProtocolBase targets for every member Protocol documents, as
    grouped stubs linking to the Protocol entries, so the ProtocolBase.*
    references across the tree resolve; document its own
    init_subclass, and keywords and length_hint under Protocol
  • drop the FRAME_LAYER_LIMIT versionremoved, a beta-only name, here and
    in protocol.py

Accuracy:

Refs #1103

…base (#1103)

protocol.rst:
- give ProtocolBase targets for every member Protocol documents, as
  grouped stubs linking to the Protocol entries, so the ProtocolBase.*
  references across the tree resolve; document its own
  __init_subclass__, and __keywords__ and __length_hint__ under Protocol
- drop the FRAME_LAYER_LIMIT versionremoved, a beta-only name, here and
  in protocol.py

Accuracy:
- register() names the public Protocol class, as ruled on #1016: put
  back the wording #1765 changed to ProtocolBase in protocol.py, PCAP
  and PCAP-NG
- HTTP/2 makers: the settings types accepted and the type check
  otherwise; sid_dep sets PRIORITY
- PCAP-NG: EPB timestamps are not in seconds; SPB's interface, timestamp
  and epoch are fixed; opt_endofopt and nrb_record_end are moved to the
  end, not ignored; NWK, not NKW
- PCAP ts_usec holds nanoseconds in a nanosecond-resolution file

Refs #1103
@JarryShaw JarryShaw added the docs Pull requests that change documentation only (docs: subject prefix) label Oct 15, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Verdict: GOOD TO GO at e05a6a957. Sonnet review and re-check (author: Opus). The first review blocked on four removed versionadded lines in schema/misc/pcapng.py, now restored. The fix round also restored the register wording to Protocol (#1016), including the lines #1765 changed, and corrected the HTTP/2 settings Raises:. The AST guard is identical against the base, tests/project passes, and every added directive says 1.5.0.

@JarryShaw JarryShaw added the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 15, 2026
@JarryShaw
JarryShaw merged commit a34f757 into main Oct 15, 2026
9 checks passed
@JarryShaw
JarryShaw deleted the docs/1103-application-r2 branch October 15, 2026 18:53
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 15, 2026
@JarryShaw JarryShaw moved this to Done in PyPCAPKit Oct 15, 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