Skip to content

docs(conventions): fix mint-criterion, process and layer-placement drift (#2549, #2550) - #2570

Merged
JarryShaw merged 2 commits into
mainfrom
docs/2549-2550-convention-drift
Nov 1, 2026
Merged

JarryShaw merged 2 commits into
mainfrom
docs/2549-2550-convention-drift

Conversation

@JarryShaw

@JarryShaw JarryShaw commented Nov 1, 2026 •

Copy link
Copy Markdown
Owner

What is the purpose of your pull request?

  • 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

  • Also tick if it regenerates constant or registry tables, members keeping their numeric values (the const label)


Description of your pull request and other information

Closes #2549, closes #2550.

…ift (#2549, #2550)

- process.rst: move const out of the Type table into a note saying it is
  additive, as breaking is, with no const: commit prefix.
- mint-criterion.rst: drop the "floor" hedge on the dead-code census, since
  Command, FEATCode and Method each reach _unregistered_member.
- mint-criterion.rst: record AppType's real-service spans (x11, ircu, swx and
  the rest) as an exception to the code-suffix case, with the reason.
- protocol-layer-placement.rst: rename the two finite-verb headings to
  "IANA Assignments: Encapsulation, Not Layer" and
  "Tunnelling Protocols: Payload, Not Carrier"; nothing else referenced them.

test_conventions_doc_claims, the issue/PR role, comment-ref, internal-ref and
project-status modules pass.
… without history (#2549, #2550)

- mint-criterion.rst: the real-service-span note states only what is true
  now and names the transport registries, which hold the members, rather
  than AppType, which holds none.
- CONTRIBUTING.md: drop const from the commit-type list and call it a label
  for regenerated constant tables, as process.rst does.
- PULL_REQUEST_TEMPLATE.md: move const out of the commit-type boxes into
  its own "Also tick if" box.
- test_conventions_doc_claims: re-pin const, which the move dropped from the
  template-to-page check, as a box outside the type list that process.rst
  says is not a type.

test_conventions_doc_claims, the PR-template, docs role/ref and other
CONTRIBUTING-reading modules 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 Nov 1, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Cross-review (Sonnet) at 23f9dd4a3: GOOD TO GO.

@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 Nov 1, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Nov 1, 2026
@github-actions

github-actions Bot commented Nov 1, 2026

Copy link
Copy Markdown
Contributor

Coverage: 93.94% (unit tier, Python 3.15, 23f9dd4a3, Unit Tests run success)

Package Statements Missed Branches Partial Cover
pcapkit (top level) 104 4 20 2 95.16%
pcapkit/const 20087 144 2710 125 98.78%
pcapkit/corekit 2605 74 818 37 96.52%
pcapkit/dumpkit 281 3 100 3 98.43%
pcapkit/foundation 3194 27 1112 31 98.65%
pcapkit/interface 138 4 52 3 96.32%
pcapkit/protocols 19906 213 5236 207 98.32%
pcapkit/toolkit 924 36 334 10 95.55%
pcapkit/utilities 502 7 144 5 98.14%
pcapkit/vendor 5009 2222 1148 182 52.31%

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

@JarryShaw
JarryShaw merged commit 11f6aae into main Nov 1, 2026
64 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Nov 1, 2026
@JarryShaw
JarryShaw deleted the docs/2549-2550-convention-drift branch November 1, 2026 15:43
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Nov 1, 2026
JarryShaw added a commit that referenced this pull request Nov 1, 2026
- Added: one's-complement checksum verification and computation (#2543),
  and the IPX and SCTP registration wrappers (#2521).
- Folded into unreleased entries: LinuxSLL/FRAD/Netlink registries (#2527),
  the IGMP class names (#2542), TLS record chaining and the SSLv2 trial's
  warnings (#2537), DTLS reassembly via Extractor and toolkit (#2528), and
  IP_Pseudo's walk at any depth (#2543). ICMP drops its stale checksum line.
- Breaking: make() checksums, DRARP's module (#2540), IPv6 overlapping
  fragments (#2569), TCP_GAP_LIMIT replacing TCP.__window__ (#2579), and
  Extractor/extract's positional dtls (#2528).
- Changed: member order (#2490), conventions (#2542, #2521, #2570), CI -n
  logical (#2572). Fixed: AppType.get (#2568), trial warnings (#2519, #2577).
- CHANGELOG.md regenerated; util/changelog_md.py --check passes.
@github-actions github-actions Bot added this to the PyPCAPKit v1.6 milestone Nov 2, 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

1 participant