Skip to content

docs(contributing): sixth whole-repo pass over the non-API docs (#1103) - #2213

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

JarryShaw merged 1 commit into
mainfrom
docs/1103-r6-docs

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

What is the purpose of your pull request?

  • docs — documentation only

Description

Part of #1103, round 6: the sixth whole-repo prose pass over the non-API docs: docs/source/contributing/ and the top-level pages, with conf.py comments only.

  • Stale claims:
    • workflows.rst: the main ruleset also requires Lint, read from the live ruleset.
    • releasing.rst: the github job's guard is quoted whole, with its PCAPKIT_RELEASED_ELSEWHERE clause.
    • registry-protocol.rst: TransportProtocol overrides get.
    • pep.rst: UDP 1701 goes to L2TPv2.
    • test-coverage.rst: a KNOWN_DEGRADED entry is a tuple of accepted error fragments plus a reason, and the asserted table is DispatchRegistryTests.KNOWN_DEGRADED.
  • Change-relative and timed: "used to", "no longer", "Until fix(ci): a half-finished release leaves a v* tag that makes every retry skip silently #888", "Since ci: declare the Python version tiers in one file, so EOL and new releases are a one-line change #1660" and "before the split" are stated as behaviour, across eight pages and conf.py.
  • Kept, because tests pin them: the releasing.rst third-party line cite (BARE_ELSEWHERE), and "backport" for compat.cached_property (test_docs_internal_refs_1940_unit).
  • Tests run:
    • test_docs_*, test_conventions_doc_claims and test_unit_tests_queue give 143 passed.
    • The workflow-prose readers give 257 passed.
    • test_python_versions_update_1660 passes, after a phrase its updater rewrites was restored.

Prose only, in the contributing pages and conf.py's comments:

- test-coverage: KNOWN_DEGRADED entries carry any-of error fragments, and
  the asserted table is DispatchRegistryTests.KNOWN_DEGRADED.
- workflows: the ruleset also requires Lint; restate change-relative
  passages (Cron Head, the schedule spread, the experimental split, the
  DPKT cut, PyUp) as behaviour.
- releasing: github's quoted guard matches create-release.yml; rewrite
  "Until #888", "before that removal", "as before" and past-tense
  third-party behaviour.
- registry-protocol: TransportProtocol overrides get too; drop "used to",
  "now", "no longer", "as before".
- pep, process, sentinel, placement, extension-header, mint-criterion and
  conf.py: drop change-relative and ambiguous wording; UDP 1701 is L2TPv2.
@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

Copy link
Copy Markdown
Owner Author

Review: GOOD TO GO at ae94eb035 (Sonnet).

  • Ruleset: main requires exactly Required checks passed, Compat Python 3.11–3.15 and Lint.
  • releasing.rst: the github guard matches create-release.yml verbatim.
  • Code claims: TransportProtocol.get exists. UDP 1701 maps to L2TPv2. The KNOWN_DEGRADED shape (any-of fragment tuple plus reason) matches both tables.
  • conf.py: the cut loses no guidance. AST guard OK.
  • Rewrites: every "Until/Since #NNN" rewrite keeps its reference and is true.
  • process.rst: "the 1.4 all carried some of them" is confirmed by me. v1.4.1.post2's all extra lists dpkt, scapy and pyshark.
  • Tests: docs, conventions, unit-tests-queue and the python-versions updater give 214 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 25, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 25, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Ready to merge at ae94eb035. Part of #1103 (round 6).

  • Review: Sonnet GOOD TO GO, first round.
  • CI: all checks complete, Required checks passed SUCCESS, 0 failed.
  • KTLO: 6 legs, no warnings.
  • Ordering: merged into main and run. project leg: 2298 tests, 0 failures.
  • Conflicts: none against the current main.

@JarryShaw JarryShaw added this to the PyPCAPKit v1.5 milestone Oct 26, 2026
@JarryShaw
JarryShaw merged commit e85e915 into main Oct 26, 2026
44 checks passed
@JarryShaw
JarryShaw deleted the docs/1103-r6-docs branch October 26, 2026 03:09
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 26, 2026
@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