Skip to content

docs(tests): state protocol, schema and misc tests' behaviour without change-relative narrative (#1103) - #2198

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

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

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 say what the behaviour is, not how a change altered it. This PR covers the files directly in tests/protocols/ plus tests/protocols/schema/ and tests/protocols/misc/. It excludes the round-trip and dispatch harness files, which #2165 owns.

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

Rewrite comments and docstrings in tests/protocols/ (top level),
tests/protocols/schema/ and tests/protocols/misc/ so they state the
behaviour under test and the defect it guards against, rather than
"now", "used to", "before the fix" or "on the unfixed tree". Comments
and docstrings only; the AST with docstrings stripped is unchanged.
@JarryShaw

Copy link
Copy Markdown
Owner Author

Rebased onto main after #2159 merged: 1f3c2ac4e → aad2f0c76.

The earlier GOOD TO GO was for 1f3c2ac4e. A delta review of this head is running.

@JarryShaw
JarryShaw force-pushed the docs/1103-cleanup-protocols branch from 1f3c2ac to aad2f0c Compare October 25, 2026 14:32
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 25, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Review: GOOD TO GO at aad2f0c76 (Sonnet delta). The three earlier nits are fixed, and the conflict resolutions keep #2159's edits. Every new hunk checks out against the code. The AST check, the changed files and the tier guard plus docstring contract all pass. One pre-existing figure on main (#646's 104 octets versus 88 by the stated arithmetic) is noted as a follow-up. This PR only changed its tense.

@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 aad2f0c76. 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: protocols leg merged into main, 1923 tests, 0 failures.

@JarryShaw
JarryShaw merged commit 4b54c94 into main Oct 25, 2026
60 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 25, 2026
@JarryShaw
JarryShaw deleted the docs/1103-cleanup-protocols branch October 25, 2026 17:49
@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