Repository navigation
docs(conventions): rulings and facts the convention pages have not caught up with #2557
Copy link
Copy link
Open
Labels
docsPull requests that change documentation only (docs: subject prefix)Pull requests that change documentation only (docs: subject prefix)wipWork in flight - a covering PR is open or an agent is actively on itWork in flight - a covering PR is open or an agent is actively on it
Description
From the 2026-11-01 conventions audit, re-verified on 73add05a3. index.rst: a ruling answered in a thread is written onto the page that covers it in the change that implements it, and each ruling names where it was settled.
- utilities-or-corekit.rst: no page records fix(protocols): convert capture timestamps without the platform's fromtimestamp limits (#2099) #2111 (
pcapkit.utilities.compatholds backports and re-exports only; a platform-independent helper such asfromtimestampgets its own module, which is whypcapkit/utilities/datetime.pyis not in it).compat.pyopens with imports and no docstring. The fix(utilities): fall back to the default threading excepthook before Python 3.10 (#1691) #1701/fix(const): give the AppType registry dict union only where dict has it (#1694) #1703 half is already pinned by a test. - protocol-layer-placement.rst, subpackage table: the
miscrow reads "file formats and layerless sentinels", butpcapkit/protocols/misc/checksum/ip_pseudo.pyIP_Pseudo(layer=None) lives there, by a ruling on feat(protocols): add the IP_Pseudo pseudo-protocol for the IP pseudo-header (#2471) #2479's thread (pseudo-header protocols go inmiscunder a checksum submodule; it closes Pseudo-protocol class for the IP pseudo-header (checksum/integrity groundwork) #2471). - protocol-layer-placement.rst,
internetrow and "Routing Protocols": "confines it to IP, ICMP and IGMP", whilepcapkit/protocols/internet/also holdsIPXand the IPsec and IPv6 extension headers that extension-header-subclassing.rst accepts. The placement is right; the wording reads as a closed list. - reassembly-integration.rst, intro: "the owner's ruling, on this session's DTLS reassembly work" names no thread. The ruling is on fix(reassembly): pin DTLS handshake buffers at declared message length #2469 (follow the RFC) and on feat(foundation): reassemble fragmented DTLS handshake messages #2451's thread (integration; it closes DTLS handshake-fragment reassembly #2440).
- protocol-family-grouping.rst: the sentence that AH and ESP are selected by
IPsecandIPv6_Extholds for IPv4-carried headers only. OnEthernet:IPv6:AH,'AH' in frame,'IPsec' in frameand'IPv6_Ext' in frameare allFalse(the headers fold intoIPv6.extension_headers); onlyframe.protochainhas them. - mint-criterion.rst, "Cache in the value table only" and the AST-walk note:
ftp.command.CommandTypeis anIntFlagregistry whose_missing_range-checks0..0x07and then callssuper()._missing_, so it behaves likeFlagsand belongs with them.
Fix: write each ruling onto its page, citing the issue it was settled on, and correct each misstated claim.
Blocked: #2528 edits reassembly-integration.rst; #2537, #2540, #2542 and #2544 edit protocol-family-grouping.rst. Unblocks when all five merge (gh pr view <n> --json state -q .state prints MERGED).
Metadata
Metadata
Assignees
Labels
docsPull requests that change documentation only (docs: subject prefix)Pull requests that change documentation only (docs: subject prefix)wipWork in flight - a covering PR is open or an agent is actively on itWork in flight - a covering PR is open or an agent is actively on it
Projects
- StatusShow more project fieldsWIP
Activity
JarryShaw commentedon Nov 1, 2026
All five blocking PRs have merged, so this is unblocked. One worker is writing these rulings together with #2563's, which edit the same pages.