Skip to content

docs(conventions): add the protocol family grouping page - #2478

Merged
JarryShaw merged 3 commits into
mainfrom
docs/2476-family-grouping-convention
Oct 31, 2026
Merged

JarryShaw merged 3 commits into
mainfrom
docs/2476-family-grouping-convention

Conversation

@JarryShaw

@JarryShaw JarryShaw commented Oct 30, 2026 •

Copy link
Copy Markdown
Owner

Please follow the guide below

What is the purpose of your pull request?

  • docs — documentation only

Description of your pull request and other information

Adds contributing/conventions/protocol-family-grouping.rst: the id() criterion, abstract family names, grouping by name, selector matching, canonical names and the _Family rule, each with its ruling's source. Sphinx adds no new warnings. Closes #2476

- New protocol-family-grouping.rst records the id() criterion (a family
  base lists only its direct concrete subclasses), abstract family names
  composing their members, grouping by name and history rather than wire
  format, the member shapes in use, RFC canonical names, what selectors
  match, and the ban on invented _Family suffixes.
- Listed in the conventions index and toctree, and added to ANCHORS in
  test_conventions_doc_claims.py so its anchor and toctree slot are pinned.

Sphinx: no new warnings; tests/project conventions tests pass.
@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 30, 2026
@github-actions github-actions Bot added this to the PyPCAPKit v1.5 milestone Oct 30, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 30, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

NEEDS CHANGES (Sonnet, 3a4651589). Every code fact the page cites is accurate, and the docs build adds no warnings. Four statements go beyond the rulings:

@JarryShaw JarryShaw added review: needs-changes Cross-review at the current head says changes are required; see the verdict comment and removed review: running A cross-review is in flight against the current head - no verdict yet labels Oct 30, 2026
- id() criterion: members-only and own-name-first tuples; ARP alone.
- Drop the Shim6 narration and the SSL/TLS/DTLS grouping.
- Versioned class names "may"; add #2443's selector ruling.
- ProtoChain also matches aliases; ARP row names RARP/DRARP on 0x8035.
- Cite pull requests with :pr:; no count.
@JarryShaw

Copy link
Copy Markdown
Owner Author

Verified (80a11f953): the page now states only the rulings plus measured main facts; "nothing else", the SSL sentence and the Shim6 caveat are gone; :pr: roles fixed. Sonnet review dispatched.

@JarryShaw JarryShaw added review: running A cross-review is in flight against the current head - no verdict yet and removed review: needs-changes Cross-review at the current head says changes are required; see the verdict comment labels Oct 30, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

NEEDS CHANGES (Sonnet, 80a11f953). The rulings are now faithful, the measured facts hold, and docs warnings equal main's. Remaining:

@JarryShaw JarryShaw added review: needs-changes Cross-review at the current head says changes are required; see the verdict comment and removed review: running A cross-review is in flight against the current head - no verdict yet labels Oct 30, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Verified (71e86243c): HTTP example replaced by VLAN (measured); DRARP fixed; inferences dropped; both canonical-name rulings stated with sources. Sonnet review dispatched.

@JarryShaw JarryShaw added review: running A cross-review is in flight against the current head - no verdict yet and removed review: needs-changes Cross-review at the current head says changes are required; see the verdict comment labels Oct 31, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

NEEDS CHANGES (Sonnet, 71e86243c). Verified facts and the Sphinx build hold. Three fixes:

@JarryShaw JarryShaw added review: needs-changes Cross-review at the current head says changes are required; see the verdict comment and removed review: running A cross-review is in flight against the current head - no verdict yet labels Oct 31, 2026
@github-actions

github-actions Bot commented Oct 31, 2026 •

Copy link
Copy Markdown
Contributor

Coverage: 94.44% (unit tier, Python 3.15, ebd7730f6, Unit Tests run success)

Package Statements Missed Branches Partial Cover
pcapkit (top level) 104 4 20 2 95.16%
pcapkit/const 19609 133 2620 120 98.84%
pcapkit/corekit 2605 74 818 37 96.52%
pcapkit/dumpkit 281 3 100 3 98.43%
pcapkit/foundation 3070 24 1072 26 98.79%
pcapkit/interface 138 4 52 3 96.32%
pcapkit/protocols 17614 193 4678 179 98.32%
pcapkit/toolkit 924 36 334 10 95.55%
pcapkit/utilities 502 7 144 5 98.14%
pcapkit/vendor 4449 1854 1020 167 55.11%

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

@JarryShaw
JarryShaw force-pushed the docs/2476-family-grouping-convention branch from 71e8624 to 509c5f6 Compare October 31, 2026 01:32
@JarryShaw JarryShaw added review: running A cross-review is in flight against the current head - no verdict yet and removed review: needs-changes Cross-review at the current head says changes are required; see the verdict comment labels Oct 31, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

NEEDS CHANGES (Sonnet, 509c5f694). id() tuples and selector claims hold on main.

@JarryShaw JarryShaw added the review: needs-changes Cross-review at the current head says changes are required; see the verdict comment label Oct 31, 2026
@JarryShaw JarryShaw removed the review: running A cross-review is in flight against the current head - no verdict yet label Oct 31, 2026
@JarryShaw
JarryShaw force-pushed the docs/2476-family-grouping-convention branch from 509c5f6 to 2521ac1 Compare October 31, 2026 01:49
@JarryShaw JarryShaw added review: running A cross-review is in flight against the current head - no verdict yet and removed review: needs-changes Cross-review at the current head says changes are required; see the verdict comment labels Oct 31, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

NEEDS CHANGES (Sonnet, 2521ac182). Measured on main (4ca3f30d7, has #2464): the IPv6_Ext key selects AH and ESP. The previous fix's claim held only for the pre-#2464 base.

  • Member Shapes (~L96-98): delete "The IPv6_Ext key does not select them…"; say AH and ESP are selected by IPsec and by IPv6_Ext.
  • ~L106 "On main," is a snapshot qualifier; drop it. PR body "checked against main" line: drop.
  • Non-blocking, owner call: :pr: cited seven times; documentation.rst says cite the issue.

@JarryShaw JarryShaw added review: needs-changes Cross-review at the current head says changes are required; see the verdict comment and removed review: running A cross-review is in flight against the current head - no verdict yet labels Oct 31, 2026
- HTTP selector example replaced by VLAN: 'S_Tag' in a C-Tag frame.
- ARP row: only RARP is bound to 0x8035; DRARP is its operation-5 alias.
- Drop the unsourced inferences and the InARP construction claim.
- State both canonical-name positions with their sources (#2444, #2446), as
  preference and proposal rather than settled rule.
- Cite the _Family rule (#2446); define registry key.
- Drop the stale IPv6_Ext claim about main, which #2464 changed.
@JarryShaw
JarryShaw force-pushed the docs/2476-family-grouping-convention branch from 2521ac1 to ebd7730 Compare October 31, 2026 02:06
@JarryShaw JarryShaw added review: running A cross-review is in flight against the current head - no verdict yet and removed review: needs-changes Cross-review at the current head says changes are required; see the verdict comment labels Oct 31, 2026
@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 31, 2026
@JarryShaw
JarryShaw merged commit 9d81037 into main Oct 31, 2026
38 checks passed
@JarryShaw
JarryShaw deleted the docs/2476-family-grouping-convention branch October 31, 2026 03:51
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 31, 2026
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 31, 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.

Convention page: protocol family grouping and the id() criterion

1 participant