Skip to content

docs(tests): state internet and link tests' behaviour without change-relative narrative (#1103) - #2201

Merged
JarryShaw merged 1 commit into
mainfrom
docs/1103-cleanup-internet
Oct 25, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
docs/1103-cleanup-internet

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

What is the purpose of your pull request?

  • docs — documentation only

Description

Part of #1103, ruling 1: test narratives say what the code does, not what a change did. This PR covers tests/protocols/internet/ and tests/protocols/link/.

…relative narrative (#1103)

Rewrite comments and docstrings under tests/protocols/internet and
tests/protocols/link that described a fix relative to the change that made
it ("now", "used to", "before this fix", "the old rule", "pre-#NNN") as
timeless statements of the behaviour, or of the defect each test guards
against. Prose only: the AST with docstrings stripped is unchanged.
@JarryShaw JarryShaw added docs Pull requests that change documentation only (docs: subject prefix) test Pull requests that add or correct tests (test: subject prefix) review: running A cross-review is in flight against the current head - no verdict yet labels Oct 25, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Review: GOOD TO GO at 10a46b36f (Sonnet). About 80 hunks were read against the code, and no change in meaning turned up. Present-tense claims match the code, including IPv6_Ext.next, the ESP bases and HIP 128/129. The 26-octet #1118 figure was re-measured before the fix. The AST check passes on all 42 files, and every changed file passes its tests. Counts and narrative already in these files that this PR leaves alone are logged for the next #1103 round.

@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 25, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 25, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Ready to merge at 10a46b36f. Part of #1103 (ruling 1).

  • Review: Sonnet GOOD TO GO.
  • CI: Required checks passed SUCCESS, 0 failed. Only the board's Sync Status is still open.
  • KTLO: 12 legs, no warnings.
  • Ordering: protocols/internet leg merged into main, 729 tests, 0 failures.
  • Conflicts: merges cleanly with the current main.

@github-actions

Copy link
Copy Markdown
Contributor

Coverage: 91.55% (unit tier, Python 3.15, 10a46b36f, Unit Tests run success)

Package Statements Missed Branches Partial Cover
pcapkit (top level) 104 4 20 2 95.16%
pcapkit/const 19599 880 2618 866 92.12%
pcapkit/corekit 2589 75 816 37 96.48%
pcapkit/dumpkit 282 3 102 3 98.44%
pcapkit/foundation 2971 23 1036 25 98.80%
pcapkit/interface 138 4 52 3 96.32%
pcapkit/protocols 17418 219 4574 185 98.14%
pcapkit/toolkit 869 36 298 10 95.20%
pcapkit/utilities 504 7 146 5 98.15%
pcapkit/vendor 4432 1988 1018 167 51.87%

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

@JarryShaw
JarryShaw merged commit 1c9ad21 into main Oct 25, 2026
66 checks passed
@JarryShaw
JarryShaw deleted the docs/1103-cleanup-internet branch October 25, 2026 21:31
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 25, 2026
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 25, 2026
@JarryShaw JarryShaw added this to the PyPCAPKit v1.5 milestone Oct 26, 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) test Pull requests that add or correct tests (test: subject prefix)

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant