Skip to content

docs(repo): third whole-repo pass over the repository files (#1103) - #1830

Merged
JarryShaw merged 1 commit into
mainfrom
docs/1103c-repo
Oct 16, 2026
Merged

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

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

Counted numbers:

  • Drop counts from workflow comments, the release-notes and coverage
    configs, README, CONTRIBUTING, MANIFEST.in, the Makefile, pyproject.toml
    comments, util/ docstrings, and the examples' docstrings and READMEs.
  • Replace lint.yml's finding tables with why the header keeps none; the
    measurements that justify a design choice stay, stated as measurements.
  • Keep the edits to line-cited files line-neutral, so the citations hold.

Accuracy:

  • lint.yml: pcap-ct is also absent, so it is an import-error source too.
  • release.yml: dependencies PRs come from pyup and Dependabot, feat and
    fix never overlap each other, and the category is "Fixes".
  • CONTRIBUTING: which _OPT_Option siblings stay documented.
  • legacy.py's frame-range comments, _engine_support.py's engine claim and
    cron-conda.yml's stale create-release.yml line citation.

Non-prose check: ast.dump is unchanged once docstrings are blanked; any workflow, TOML or script edits are comment-only (parsed and compared). Narrow test runs are green (tests/project and the tests that read edited files).

Refs #1103

Counted numbers:
- Drop counts from workflow comments, the release-notes and coverage
  configs, README, CONTRIBUTING, MANIFEST.in, the Makefile, pyproject.toml
  comments, util/ docstrings, and the examples' docstrings and READMEs.
- Replace lint.yml's finding tables with why the header keeps none; the
  measurements that justify a design choice stay, stated as measurements.
- Keep the edits to line-cited files line-neutral, so the citations hold.

Accuracy:
- lint.yml: pcap-ct is also absent, so it is an import-error source too.
- release.yml: dependencies PRs come from pyup and Dependabot, feat and
  fix never overlap each other, and the category is "Fixes".
- CONTRIBUTING: which _OPT_Option siblings stay documented.
- legacy.py's frame-range comments, _engine_support.py's engine claim and
  cron-conda.yml's stale create-release.yml line citation.

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 16, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 16, 2026
@JarryShaw
JarryShaw merged commit 91c4772 into main Oct 16, 2026
54 checks passed
@JarryShaw
JarryShaw deleted the docs/1103c-repo branch October 16, 2026 20:12
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 16, 2026
@JarryShaw JarryShaw removed the review: running A cross-review is in flight against the current head - no verdict yet label Oct 16, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Verdict: NEEDS CHANGES at 0232dd812 (merged as 91c4772ae). A Sonnet cross-review (author: Opus) confirmed:

  • each generalised create-release.yml comment against the jobs it describes;
  • the release.yml claims: dependency PRs come from pyup and Dependabot, and no PR carries both feat and fix;
  • pcap-ct as a lint import-error source;
  • the legacy.py frame ranges, by regenerating the capture;
  • line neutrality for every file:line citation in the repo;
  • the YAML, TOML and AST equivalence. It also ran the workflow tests: test_release_gates (125) and the others, all passing.

Two blocking defects, both re-checked on main. In each, a removed count became a false "every":

  • create-release.yml:151 "only for every job below to skip": vendor_update, version_check and release_status do not skip, only the publishers do;
  • unit-tests.yml:685-686 "loops over every interpreter … every Python times every engine": the same comment excludes 3.7-3.9.

These are workflow files, so the fix goes in a follow-up PR.

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