Skip to content

docs(tests): state const tests' behaviour without change-relative narrative (#1103) - #2200

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

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

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 in tests/const/ describe the behaviour instead of the change that produced it.

  • Rewrites:
  • Stale claims corrected against the code:
    • TransportProtocol.get raises a KeyError, not a ValueError.
    • Port 3 resolves as sctp.
    • EtherType no longer mints.
  • Kept:
    • "no longer" and "now" where they describe the runtime or a step of the test.
    • Change-relative assertion messages and test names. These are code, and other files cite them.
  • Scope: comments and docstrings only. With docstrings stripped, every changed file has the same AST as main.
  • Tests run: the slice by group, plus the tier guard, the docstring contract and the RFC-anchor and doc-ref project tests, all pass.
  • Overlap: none with open PRs.

@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: NEEDS CHANGES at 4ca9bf5d4 (Sonnet).

@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 25, 2026
…rative (#1103)

Rewrites comments and docstrings under tests/const/ so they describe
behaviour and the defect each test guards against, not the change that
introduced it. Prose only; AST-identical once docstrings are stripped.
@JarryShaw

Copy link
Copy Markdown
Owner Author

Review fixes pushed: 4ca9bf5d4 → 525dc7350, rebased onto main.

@JarryShaw
JarryShaw force-pushed the docs/1103-cleanup-const branch from 4ca9bf5 to 525dc73 Compare October 25, 2026 14:44
@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 25, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 25, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Review: GOOD TO GO at 525dc7350 (Sonnet delta).

@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

Copy link
Copy Markdown
Owner Author

Ready to merge at 525dc7350. Part of #1103 (ruling 1).

  • Review: Sonnet GOOD TO GO.
  • CI: all checks complete, Required checks passed SUCCESS, 0 failed.
  • KTLO: 12 legs, no warnings.
  • Ordering: const leg merged into main: 597 tests, 0 failures.
  • Conflicts: none with the current main.

@github-actions

Copy link
Copy Markdown
Contributor

Coverage: 91.55% (unit tier, Python 3.15, 525dc7350, 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 17428 219 4584 185 98.15%
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 8ec97ad into main Oct 25, 2026
64 checks passed
@JarryShaw
JarryShaw deleted the docs/1103-cleanup-const branch October 25, 2026 21:30
@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