Skip to content

docs(tests): state corekit, utilities and dumpkit tests' behaviour without change-relative narrative (#1103) - #2202

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

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

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/corekit/ (except _roundtrip.py), tests/utilities/, tests/dumpkit/, tests/interface/ and tests/cli/ now state the behaviour, not how a change produced it.

  • Rewrites:
    • "used to …" becomes "Without the fix, … returns …".
    • "now" and "no longer" become the present tense.
    • Process and measurement histories are cut, but ruled-out alternatives keep their reasons.
  • Stale claims corrected against the code:
  • Kept:
    • Runtime or third-party "now" and "no longer".
    • The moved-name tests' "old path", which is the subject of those tests.
    • Change-relative string literals and test names, which are code.
  • Scope: comments and docstrings only. Once docstrings are stripped, every changed file has the same AST as main.
  • Tests run: cli, interface, utilities and dumpkit pass (223), corekit passes (499), and so do the tier guard and docstring contract (140).
  • Overlap: docs(corekit): say which generated registries bound their width (#2178) #2192 shares one file and merges cleanly.

@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 2c80e6bb2 (Sonnet). Files this PR edits still carry change-relative proofs:

There is also one garbled sentence. The rewrites themselves hold against the code, cross-references resolve, the subtest sentence is accurate and the tests pass. The worker is fixing the rest.

@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
…thout change-relative narrative (#1103)

Rewrite comments and docstrings in tests/corekit (except _roundtrip.py),
tests/utilities, tests/dumpkit, tests/interface and tests/cli so they state
the behaviour pinned and the defect guarded against ("without the fix ...")
rather than narrating a change ("now", "used to", "before this change").
Pure history is cut. Prose only: the AST with docstrings stripped is unchanged.
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 25, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Review fixes pushed: 2c80e6bb2 → d0e35e388, rebased onto main.

The AST check is clean on all 57 files, and the slice tests pass. A delta review is running.

@JarryShaw
JarryShaw force-pushed the docs/1103-cleanup-corekit branch from 2c80e6b to d0e35e3 Compare October 25, 2026 14:57
@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

Copy link
Copy Markdown
Owner Author

Review: GOOD TO GO at d0e35e388 (Sonnet delta). Every earlier item is fixed and checked against the code, and only the intended hunks and pure reflows moved. The change-relative grep finds nothing in the 57 files. AST is clean, and corekit, utilities, dumpkit, interface, cli, the docstring contract and the tier guard all pass (1107).

@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 d0e35e388. Part of #1103 (ruling 1).

  • Review: Sonnet GOOD TO GO, after one NEEDS CHANGES round.
  • CI: all checks complete, Required checks passed SUCCESS, 0 failed.
  • KTLO: 12 legs, no warnings.
  • Ordering: the corekit leg was merged into main and run: 924 tests, 0 failures.
  • Conflicts: none against the current main.

@github-actions

Copy link
Copy Markdown
Contributor

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

Package Statements Missed Branches Partial Cover
pcapkit (top level) 104 4 20 2 95.16%
pcapkit/const 19599 881 2618 867 92.11%
pcapkit/corekit 2589 74 816 37 96.51%
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 17433 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 71d7be7 into main Oct 25, 2026
64 checks passed
@JarryShaw
JarryShaw deleted the docs/1103-cleanup-corekit 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