Skip to content

docs(tests): correct stale claims in test docstrings and comments (#1103) - #1764

Merged
JarryShaw merged 2 commits into
mainfrom
docs/1103-tests
Oct 15, 2026
Merged

JarryShaw merged 2 commits into
mainfrom
docs/1103-tests

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

Please follow the guide below

What is the purpose of your pull request?

Tick the commit type your subject line carries.

  • fix — corrects a defect
  • feat — adds a feature
  • perf — changes performance, not behaviour
  • refactor — changes neither behaviour nor performance
  • test — tests only
  • docs — documentation only
  • ci — workflows or build tooling
  • release — bumps the version or rolls up a distribution
  • chore — anything else

Description

Part of #1103, the whole-repository prose sweep, for the tests slice. It follows the #719 rules: prose only, accuracy first, no churn and no timed context.

Prose only: the AST of every changed module, string expression
statements blanked, is identical to origin/main's.

Checks:

  • An AST guard holds on every changed .py: code is identical once docstrings are blanked.
  • tests/project and every test that reads the edited paths pass.
  • A merged Sphinx build of all nine slices adds no new warnings.
  • A Sonnet cross-review returned GOOD TO GO.

Not covered here; a round-2 PR follows: function, method and class docstrings and inline comments (about 2.3 MB), starting with the largest files.

Refs #1103

)

Prose only: the AST of every changed module, string expression
statements blanked, is identical to origin/main's.

- Timed context: "this PR" names its PR (#755, #802, #836, #854,
  #869, #874, #922, #926); "today", "as of writing", "right now",
  "until now" and a "now installs" are anchored or dropped.
- Stale state: closed issues no longer read as open or in flight
  (#576, #651/#664, #674, #527, #531), and the minting, KNOWN_DEFECTS,
  vendor-depth and MPTCP-parse narratives are put in the past tense
  where later changes retired them.
- Moved or renamed names: beholder's home, HTTP._read_http_header,
  PCAPNGSectionRuleTests, test_new_engine_parity_runtime, and the
  scapy cast that #1652 removed.
- Line references: about 50 file:line pointers into pcapkit/,
  pyproject.toml, Pipfile and sibling tests re-measured.
- Counts re-derived: raise targets and nested defs in
  test_docstring_contract, and the four returned nested defs it names.
- A pytest-subtests claim corrected to pytest's own reporting.

Refs #1103
@JarryShaw JarryShaw added the docs Pull requests that change documentation only (docs: subject prefix) label Oct 15, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Verdict: GOOD TO GO at 4db995523. A Sonnet cross-review checked it (author: Opus).

  • Scope and AST guard: 50 files, all under tests/. All 50 are identical once docstrings are blanked, and the check catches a changed literal while ignoring a changed docstring. No assertion, name or fixture changed.
  • Accuracy: every hunk was read and about 65 claims were checked, with 0 wrong claims and 0 churn. The 24 swaps from "this PR" to #N each match the git blame PR of the original line.
  • Non-blocking, for round 2:

@JarryShaw JarryShaw added the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 15, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 15, 2026
@JarryShaw
JarryShaw merged commit 5fa777a into main Oct 15, 2026
4 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 15, 2026
@JarryShaw
JarryShaw deleted the docs/1103-tests branch October 15, 2026 17:17
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 15, 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)

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant