Skip to content

docs: seventh whole-repo pass over the non-API docs (#1103) - #2266

Merged
JarryShaw merged 1 commit into
mainfrom
docs/1103-r7-docs-pr
Oct 26, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
docs/1103-r7-docs-pr

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

What is the purpose of your pull request?

  • docs — documentation only

Description

Part of #1103, round 7. A full read of everything under docs/ except the API pages and the changelog. The one .py file (conf.py) passes the AST guard.

  • workflows.rst:
  • protocol-layer-placement.rst: FTP_DATA subclasses Raw alone, so its layer is None; the example now uses a class naming both bases.
  • test-coverage.rst: HIP_COPIES is restated as behaviour; it is 1.
  • registry-protocol.rst and conf.py: the audit-table rows and two hook docstrings are restated as behaviour. The extlinks comment is scoped to the citations it covers.
  • Tests: docs tests, test_conventions_doc_claims, test_codeql_config_2130, the 1967 script tests and the light-PR and pins tests pass. No text pins.

Full read of docs/ outside the API pages and the changelog.

- workflows.rst: the docs-only project-tests row runs all of tests/project;
  project pins skip a docs-only diff; run_unittest_leg runs once per cell and
  per half; the queue-wait estimate restated; release-script pins and the
  CodeQL passage in present tense.
- protocol-layer-placement.rst: FTP_DATA names Raw alone.
- test-coverage.rst: HIP_COPIES restated as behaviour.
- registry-protocol.rst audit table and conf.py hook docstrings restated as
  behaviour; extlinks comment scoped.
@JarryShaw JarryShaw added this to the PyPCAPKit v1.5 milestone Oct 26, 2026
@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 26, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Review: GOOD TO GO at 5562ab0f2 (Sonnet).

  • Prose only: the conf.py AST guard is identical.
  • Claims: each claim checked against the workflow and code holds:
  • Tests: the workflow readers, conventions, tier guard and docs tests give 792 passed. No text pins.

@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 26, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 26, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Ready to merge at 5562ab0f2. Part of #1103, round 7: the non-API docs.

  • Review: Sonnet GOOD TO GO.
  • CI: all checks complete, Required checks passed SUCCESS, 0 failed. Sync Status is board sync, not CI.
  • KTLO: no warnings.
  • Ordering: merged into main and run. project leg: 2402 tests, 0 failures.
  • Conflicts: none against the current main.

@JarryShaw
JarryShaw merged commit 9c628e5 into main Oct 26, 2026
39 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 26, 2026
@JarryShaw
JarryShaw deleted the docs/1103-r7-docs-pr branch October 26, 2026 20:23
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label 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