Skip to content

docs(repo): fifth whole-repo pass over the repository files (#1103) - #2158

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

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

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

What is the purpose of your pull request?

  • docs — documentation only

Description

Part of #1103 round 5, repository-files slice, on main at 4c3d30163. Prose and comments only.

Checks

  • AST: with docstrings stripped, the AST is identical on the 12 changed .py files.
  • actionlint 1.7.12: the branch reports the same 4 findings as main and adds none.

Stale or false claims fixed

Rule fixes

  • Timed context removed: "now that", "yet".
  • Counts removed: "three nested limits", "two util/ scripts", and others.
  • The generators' file:line anchors now name ARP.read and PCAPNG.run.

Tests: tests/project/test_docs_* plus the conventions test, 94 passed. The 77 tests/project modules that read the changed files, 1565 passed.

Stale claims: the benchmark workflow and Makefile point at the speed
tables on docs/source/engines.rst; bump_version.py's docstring accounts
for the release approval (#887) and drops the "no bump took more than a
day" claim 1.5.0b9 disproves; CONTRIBUTING.md no longer says no linter is
clean, that nothing checks isort, or that vermin fails on a 3.11 minimum;
README.md says CHANGELOG.md holds the newest entry; discussion_report.py
and leg_summary.py name their callers; run_unittest_leg.py no longer
cites a timing table the workflow lost; _actions.py drops the 3.7 legs.

Timed context and counts: "now that", "yet", "moves to from", "three
nested limits", "in two/three forms" and similar, reworded.

Line anchors: two in-repo file:line citations in examples/generators/
now name ARP.read and PCAPNG.run.

Comments and docstrings only: AST guard clean, actionlint 1.7.12 clean.
@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 JarryShaw moved this to In review in PyPCAPKit Oct 25, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

GOOD TO GO at 158224902 (Sonnet review).

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

Copy link
Copy Markdown
Contributor

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

  • Review: Sonnet GOOD TO GO. The YAML of all 16 workflows parses identically to main; this PR changes comments only.
  • CI: all 61 CheckRuns passed, none failed or pending. 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.

@JarryShaw
JarryShaw merged commit c17f744 into main Oct 25, 2026
65 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-r5-repo branch October 25, 2026 14:14
@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)

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant