Skip to content

docs: retire the counted numbers that tests and the python-versions updater pin (#1811) - #1817

Merged
JarryShaw merged 1 commit into
mainfrom
docs/1811-retire-count-pins
Oct 16, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
docs/1811-retire-count-pins

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

Summary

Applies the ruling on #1103 (no counted numbers in the docs) to the pages whose counts tests and the python-versions updater pinned. The prose and its pins go in one change.

  • Prose: process.rst, registry-protocol.rst, sentinel-convention.rst, workflows.rst and releasing.rst lose their pinned counts and the sentences that quoted them. Each rewrite was checked against the tree.

  • Pins: each is deleted, or replaced by a check of the underlying fact without a number in prose:

    • changelog sections must be exactly one per package plus Project infrastructure;
    • the sentinel table must match the module's singletons both ways;
    • every workflow file needs a row and a graph node;
    • the gate-only list must equal unit-tests.yml's gated matrix jobs;
    • the hand-kept experimental legs must be experimental.yml's.

    Every replacement guard fails when its fact breaks.

  • Updater (util/): the claims that rewrote counts are gone, and every version-range and latest-version claim stays. No workflow YAML changes.

  • Runs: tests/project and the sentinel test pass, and the changed modules pass under plain unittest too.

Unpinned counts on these pages are left for #1103's round 3.

Closes #1811

…pdater pin (#1811)

Under #1103's ruling, the pinned counts in process.rst, registry-protocol.rst,
sentinel-convention.rst, workflows.rst and releasing.rst become count-free,
along with the sentences that restated them.

- Pins that only matched a number are deleted: the changelog entry count, the
  phase-two and audit figures, the helper tally, the workflow count, the leg
  counts and the release-check counts.
- Pins that guarded a real fact now check it by name: the sentinel table matches
  the module's singletons, phase 2 has no enumeration outside the hierarchy, the
  helper row names each helper, the changelog sections match the packages, and
  the gate-only list matches unit-tests.yml's gated matrix jobs.
- util/update_python_versions.py drops its count claims and the Word machinery.
  Its version and line-citation claims stay.

tests/project: 966 passed, 1 skipped. Each new guard fails on a broken scratch copy.

Closes #1811
@JarryShaw JarryShaw added the docs Pull requests that change documentation only (docs: subject prefix) label Oct 16, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Verdict: GOOD TO GO at 197bf1952. A Sonnet cross-review (author: Opus) checked each rewritten sentence against the tree: the gated jobs in unit-tests.yml, experimental.yml's matrix, a runtime walk of the enumerations, and the changelog sections. It found no remaining pin that matches a number in prose. Each replacement guard fails when its fact breaks. The updater still rewrites versions, and no workflow YAML changed. tests/project passes, and the changed modules pass under plain unittest. No file of another open PR is touched.

@JarryShaw JarryShaw added the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 16, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 16, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Coverage: 89.60% (unit tier, Python 3.15, 197bf1952, Unit Tests run success)

Package Statements Missed Branches Partial Cover
pcapkit (top level) 104 3 20 3 95.16%
pcapkit/const 18862 954 2368 868 91.06%
pcapkit/corekit 2462 69 780 35 96.55%
pcapkit/dumpkit 276 3 100 3 98.40%
pcapkit/foundation 2915 164 1016 34 93.59%
pcapkit/interface 138 7 52 5 93.68%
pcapkit/protocols 17197 224 4580 189 98.09%
pcapkit/toolkit 872 177 298 8 77.18%
pcapkit/utilities 512 2 158 4 99.10%
pcapkit/vendor 4417 2342 1010 157 43.38%

Per-file detail: the coverage-html artifact of this run.

@JarryShaw
JarryShaw merged commit f598ea6 into main Oct 16, 2026
56 checks passed
@JarryShaw
JarryShaw deleted the docs/1811-retire-count-pins branch October 16, 2026 13:14
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 16, 2026
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 16, 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.

docs: retire the counted numbers that tests and the python-versions updater pin

1 participant