Skip to content

docs(tests): fifth whole-repo pass over tests (#1103) - #2159

Merged
JarryShaw merged 1 commit into
mainfrom
docs/1103-r5-tests
Oct 25, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
docs/1103-r5-tests

Conversation

@JarryShaw

@JarryShaw JarryShaw commented Oct 25, 2026 •

Copy link
Copy Markdown
Owner

What is the purpose of your pull request?

  • docs — documentation only

Description

Part of #1103, round 5: the tests slice, on main 4c3d30163. This PR changes only test docstrings and comments. With docstrings stripped, the AST of all 91 changed files is identical, and no asserted string or test name changes.

  • Stale claims, corrected:
    • actionlint blocks Lint; it is not advisory.
    • The Windows conda leg is back since Conda: bring back the Windows (win-64) package, in two phases #2060.
    • The Lint job as a whole is not advisory; its pylint step is (as are bandit, vermin and mypy).
    • The tier-guard lock polls on GraalPy only.
    • The name= collision affects every Python below 3.11.
    • A stale pyproject.toml:238 citation now names the entry.
  • file:line anchors: about 80 replaced with names. That covers in-repo code and third-party sources at their pinned versions (release actions, cli, runner, setup-python, Wireshark, Sphinx, aenum); each was read at its tag before it was named.
  • Counts and timed context: removed from prose added since round 4.
  • Tests:
    • The docs, conventions and issue-refs tests: 147 passed.
    • The 41 changed tests/project files: 852 passed.
    • The other 41 changed test files: 762 passed.

Accuracy:
- experimental.yml's shellcheck pin no longer calls actionlint advisory;
  a finding fails Lint
- the conda jobs had no Windows leg from 2023 until #2060, not "since"
- the pylint pragma check names Lint's pylint step as the advisory one
- the tier lock polls with LOCK_NB on GraalPy only
- the name= class-keyword collision is below 3.11, not 3.10 alone

Anchors:
- replace file:line citations with function, class, step or section
  names, in-repo and in the pinned third-party sources

Counts and timed context:
- drop codebase counts and "now", "today", "any more", "yet" from prose
  added since round 4

Prose only: an AST guard with docstrings blanked is identical on every file.

Refs #1103
@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 Oct 25, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

GOOD TO GO at 77ebf4a72 (Sonnet review).

  • AST guard: OK on all 91 files. No non-docstring string literal changed, so no assertion or test name moved.
  • Stale claims (all confirmed):
  • Anchors: more than 30 checked at the pinned tags; every named symbol exists and covers the old line.
    • ncipollo v1.21.0 (updateRelease, createOrUpdateRelease, …)
    • action-gh-release 3.0.2, create-github-app-token v3.3.0, cli/cli v2.102.0 (uploadRun)
    • actions/runner 5f0b3ddcc (StepsRunner.RunStepAsync, ActionCommand.TryParseV2)
    • setup-python 3892123fb, Wireshark 4.2.2 (dissect_frame)
    • Sphinx and aenum, plus the in-repo classes and tests
  • Count and timed-context edits: about 25 sampled; all keep their meaning.
  • Tests: docs/conventions/issue-refs/tier-guard 232 passed; 24 changed test files 467 passed.
  • PR description fixed: I had summarised one change as "only pylint's step is advisory". That is wrong, since bandit, vermin and mypy are advisory too. The test text itself says "Lint's pylint step is advisory", which is true.

@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
@github-actions

Copy link
Copy Markdown
Contributor

Coverage: 91.55% (unit tier, Python 3.15, 77ebf4a72, 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

Copy link
Copy Markdown
Owner Author

Ready to merge at 77ebf4a72.

  • Review: Sonnet GOOD TO GO. The AST guard is OK on all 91 files, and over 30 anchors were checked at their pinned tags.
  • CI: all 61 CheckRuns passed, none failed or still running. Required checks passed is SUCCESS, and the KTLO legs show no warnings.
  • Ordering: I merged this PR into main and ran tests/project plus the root modules under the plain unittest ordering leg: 2288 tests, 0 failures, 0 errors.
  • Conflicts: none with the other round-5 PRs, including test(protocols): keep the frame-layer-limit timing bound stable on PyPy (#2160) #2162, which edits a test file this PR doesn't touch.

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

Development

Successfully merging this pull request may close these issues.

1 participant