Skip to content

docs(repo): correct stale claims and drop timed context in repo files (#1103) - #1768

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

JarryShaw merged 1 commit into
mainfrom
docs/1103-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

Description

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

Accuracy -- claims that no longer matched the tree:

  • README: len(flows.trace) is 1 on main, not 3; show .trace.tcp, 2.
  • Makefile, lint.yml: make vermin stops at its redirect when vermin
    exits 1; it does not succeed through the editor line.
  • create-release.yml: version_check's snippets run after setup-python;
    unit-tests.yml: all four callers pass gate-only.
  • dispatch.py: 47 entries in eight tables, two degraded; coverage.toml
    adds four settings, not three.
  • python-versions.toml, the pyproject zip-safe note, the Makefile bench
    note, lint.yml's typing_extensions count, CONTRIBUTING's registry count.

Timed context: about 95 "now", "today", "currently", "yet", "this PR"
and comment-history phrases removed across the workflows, configs,
example generators, the benchmark and util/bump_version.py.

Comments and docstrings only: changed .py files keep an identical AST
with string expressions blanked; YAML/TOML load identically except for
shell comments in two run: blocks. tests/project passes.

Checks:

  • An AST guard holds on every changed .py file.
  • YAML waiver. Two hunks change shell comment lines (# lines) inside run: scripts in create-release.yml and cron-vendor.yml. With those lines stripped, both scripts are identical; declare -f of each confirms nothing executes differently. Every other YAML file loads equal.
  • tests/project gives 930 passed and 1 skipped, and every test that reads the edited paths passes.
  • A merged Sphinx build of all nine slices adds no new warnings.
  • A Sonnet cross-review sent this back once. After the fix round, a re-check returned GOOD TO GO.

Not covered here; a round-2 PR follows: the files that were only grepped, the stale IPX text in examples/generators/dispatch.py, and the lint.yml header counts, which need re-measuring.

Refs #1103

…#1103)

Accuracy -- claims that no longer matched the tree:
- README: `len(flows.trace)` is 1 on main, not 3; show `.trace.tcp`, 2.
- Makefile, lint.yml: `make vermin` stops at its redirect when vermin
  exits 1; it does not succeed through the editor line.
- create-release.yml: version_check's snippets run after setup-python;
  unit-tests.yml: all four callers pass `gate-only`.
- dispatch.py: 47 entries in eight tables, two degraded; coverage.toml
  adds four settings, not three.
- python-versions.toml, the pyproject zip-safe note, the Makefile bench
  note, lint.yml's typing_extensions count, CONTRIBUTING's registry count.

Timed context: about 95 "now", "today", "currently", "yet", "this PR"
and comment-history phrases removed across the workflows, configs,
example generators, the benchmark and util/bump_version.py.

Comments and docstrings only: changed .py files keep an identical AST
with string expressions blanked; YAML/TOML load identically except for
shell comments in two `run:` blocks. tests/project passes.

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 5b06a3d70. A Sonnet cross-review checked it (author: Opus), after one fix round.

  • First review: the YAML guard failed on two run: scalars.
  • Waiver: I waived the guard for shell comment lines. The re-check proved the condition:
    • only # lines differ, and the scalars are identical once those lines are stripped;
    • the scripts contain no heredocs, and declare -f output is identical;
    • controls confirm the check catches a real change.
  • Makefile: the self-contradicting clause is gone, and make vermin RUN= was re-measured.
  • Guards: the AST, TOML and non-comment line checks all hold.
  • Tests: tests/project gives 930 passed.

@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 3f11e7b into main Oct 15, 2026
53 checks passed
@JarryShaw
JarryShaw deleted the docs/1103-repo branch October 15, 2026 17:19
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 15, 2026
@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