Skip to content

docs(tests): state project tests' behaviour without change-relative narrative (#1103) - #2203

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

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

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

What is the purpose of your pull request?

  • docs — documentation only

Description

Part of #1103, ruling 1: the narratives in tests/project/ say what the code does now, not how a change got it there. #2199 owns test_python_versions_1660.py and test_resource_monitor_1740.py, so this PR leaves them out.

@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 9ac00865e (Sonnet). Two prose comments are still change-relative: the #: comment's "before #2040" in test_unit_tests_push_reports_2030.py, and "where a bare struct.error used to" in test_conventions_doc_claims.py. The opening of test_conda_no_windows_steps_1967.py's docstring is also garbled. Everything else checks out: present-tense claims hold, including both conda Windows legs, the AST check is clean, and the tests pass. The worker is fixing the three items.

@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
…arrative (#1103)

Rewrite comments and docstrings in tests/project that describe a fix relative to the change ("now", "no longer", "used to", "before #NNN", "the old X") as timeless statements of the behaviour pinned or the defect guarded against; cut history that only reads as history. Prose only: every changed module's AST is identical once docstrings are stripped.
@JarryShaw

Copy link
Copy Markdown
Owner Author

Review fixes pushed: 9ac00865e → 9463a15f5, rebased onto main.

The AST check is clean, and the touched files pass their tests. A delta review is running.

@JarryShaw
JarryShaw force-pushed the docs/1103-cleanup-project branch from 9ac0086 to 9463a15 Compare October 25, 2026 14:51
@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 9463a15f5 (Sonnet delta). All four items are fixed, and range-diff shows nothing else moved. The AST check is clean, and the touched files pass along with the tier guard and the docstring contract (245). A few remaining "pre-#910" / "pre-fix" phrases, which describe a mutation measurement or fixture, 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 9463a15f5. Part of #1103 (ruling 1).

  • Review: Sonnet GOOD TO GO, after a NEEDS CHANGES round.
  • CI: all checks complete, Required checks passed SUCCESS, 0 failed.
  • KTLO: 12 legs, no warnings.
  • Ordering: project leg merged into main, 2290 tests, 0 failures.
  • Conflicts: none with the current main.

@github-actions

Copy link
Copy Markdown
Contributor

Coverage: 91.55% (unit tier, Python 3.15, 9463a15f5, 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 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 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 c1a2236 into main Oct 25, 2026
64 checks passed
@JarryShaw
JarryShaw deleted the docs/1103-cleanup-project branch October 25, 2026 21:32
@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