Skip to content

docs(docs): fourth whole-repo pass over the non-API docs (#1103) - #1912

Merged
JarryShaw merged 1 commit into
mainfrom
docs/1103d-docs
Oct 19, 2026
Merged

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

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

The fourth whole-repo prose pass of #1103, over the hand-written docs pages, every index and toctree. It changes prose only: every changed .py file's AST is unchanged once string expressions are blanked, except where a docstring is added or vendor template text is edited together with its generated const file.

Accuracy:

  • registry-protocol: a loud BaseError logs CRITICAL and installs the
    exception hooks; it no longer sets sys.tracebacklimit
  • pep: only the docs build installs .[all,dev] on macOS; SCTP named as
    the one checksum verifier
  • protocol-layer-placement: ARP and RARP have different EtherTypes
  • extension-header-subclassing: IPsec is not already in the MRO
  • engines index: PyPCAP's Python range matches its <3.12 marker
  • releasing, mint-criterion: stale line citations fixed or dropped

Counts and timed context removed from workflows, ext, conf.py, the
layer-placement page, pep and the pcapkit index.

Clarity: the engine-gap exceptions on the overview, ext and pep pages,
the gate-only sentence and tier sentence in workflows, and grammar in
the API index pages; unresolved str and copyreg references fixed.

Refs #1103

Accuracy:
- registry-protocol: a loud BaseError logs CRITICAL and installs the
  exception hooks; it no longer sets sys.tracebacklimit
- pep: only the docs build installs .[all,dev] on macOS; SCTP named as
  the one checksum verifier
- protocol-layer-placement: ARP and RARP have different EtherTypes
- extension-header-subclassing: IPsec is not already in the MRO
- engines index: PyPCAP's Python range matches its <3.12 marker
- releasing, mint-criterion: stale line citations fixed or dropped

Counts and timed context removed from workflows, ext, conf.py, the
layer-placement page, pep and the pcapkit index.

Clarity: the engine-gap exceptions on the overview, ext and pep pages,
the gate-only sentence and tier sentence in workflows, and grammar in
the API index pages; unresolved str and copyreg references fixed.

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

Copy link
Copy Markdown
Owner Author

GOOD TO GO at 3a09a6e39. A Sonnet cross-review checked the reworded docs pages against the code they describe and found no counts, timed context or broken markup. The pinned docs build has no warnings.

@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 19, 2026
JarryShaw added a commit that referenced this pull request Oct 19, 2026
 (#1103)

- Reword the pcapkit.interface module docstring to the page text #1912
  sets: its exports are interface functions and constant macros.
- Revert this branch's edit to docs/source/pcapkit/interface/index.rst,
  which #1912 owns.
@JarryShaw
JarryShaw merged commit 2b4ab0c into main Oct 19, 2026
41 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 19, 2026
@JarryShaw
JarryShaw deleted the docs/1103d-docs branch October 19, 2026 14:13
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 19, 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