Repository navigation
docs(conventions): add the protocol family grouping page - #2478
Conversation
- 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.
|
NEEDS CHANGES (Sonnet,
|
- 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.
|
Verified ( |
|
NEEDS CHANGES (Sonnet,
|
|
Verified ( |
|
NEEDS CHANGES (Sonnet,
|
|
Coverage: 94.44% (unit tier, Python 3.15,
Per-file detail: the |
71e8624 to
509c5f6
Compare
|
NEEDS CHANGES (Sonnet,
|
509c5f6 to
2521ac1
Compare
|
NEEDS CHANGES (Sonnet,
|
- 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.
2521ac1 to
ebd7730
Compare
Please follow the guide below
make pylint,make mypy,make isort) -- nopcapkit/file is touchedmake testpasses, and a test case covers the change -- the page is pinned intest_conventions_doc_claims.py'sANCHORSdocs/source/changelog/and regeneratedCHANGELOG.md, if the change is user-visible -- N/A, centralised in chore(docs): centralize 1.6.0 changelog updates in one place, not per-feature-PR #2449What is the purpose of your pull request?
docs— documentation onlyDescription of your pull request and other information
Adds
contributing/conventions/protocol-family-grouping.rst: theid()criterion, abstract family names, grouping by name, selector matching, canonical names and the_Familyrule, each with its ruling's source. Sphinx adds no new warnings. Closes #2476