Skip to content

docs(autodoc): cut timed context from the non-protocol autodoc pages (#719) - #1043

Merged
JarryShaw merged 1 commit into
mainfrom
docs/719-autodoc-core
Oct 5, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
docs/719-autodoc-core

Conversation

@JarryShaw

@JarryShaw JarryShaw commented Oct 5, 2026 •

Copy link
Copy Markdown
Owner

What is the purpose of your pull request?

  • docs — documentation only

Description of your pull request and other information

Slice of #719: docs/source/pcapkit/** except protocols/ (18 files, +143 / -159). Cuts host-specific "measured on" logs, "has since landed" / "was added" / "now" prose; keeps every rationale. Fixes: engine constraint claim (PyPCAP has no Python-ceiling check), interface table missing 3 engine constants, typing.final gate 3.11 in the compat table, heading typos.

Not touched: corekit/, dumpkit/, toolkit/, utilities/logging.rst, foundation/registry.rst, engines/builtin.rst, engines/engine.rst, most const/ and vendor/ pages (generated autodoc, nothing to cut), and the TCP/IPv6 reassembly data-model blocks beyond the two timed phrases. The slice was not fully rewritten.

Checks: sphinx-build -b dummy -n fresh dirs, branch vs main, slice warnings 47 vs 47, none new (1301 vs 1301 total). tests/project 274 passed.

@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 5, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Cross-review verdict on cdb7f6965: NEEDS CHANGES (ran on Opus; authored on Sonnet). Two sentences in the rewritten engines paragraph are wrong against the code, and one PR-body tickbox overclaims.

  1. foundation/engines/index.rst:142-143 omits PyShark's tshark check. PyShark.unsupported_reason checks its Python ceiling and whether get_process_path() finds tshark (pyshark.py:126, :134-144). The list reads as complete, so a reader would conclude a missing tshark goes uncaught.
  2. :144-145 gives the opposite of PyPCAP's real reason. The page says PyPCAP has no Python ceiling "since upstream cannot be installed above it". The docstring (pypcap.py:148-151) says it is deliberately not a ceiling even though upstream cannot install on 3.12+, because the check is which distribution is present: a version check would refuse a working build. docs: sweep all prose for concision and accuracy, and drop timed context outside the changelog #719 keeps design reasons, so use the real one or drop the clause.
  3. PR body: the "make test passes, and a test case covers the change" box should read "N/A — docs only; tests/project passes". No test was added and only tests/project ran. The same applies to the lint and type-check box.

Confirmed:

  • Removing "every engine overrides unsupported_reason" is right: only PyShark, PyPCAP, PCAP_CT and PyPCAPFile define one.
  • The three new interface rows render: the table goes from 18 to 21 rows.
  • typing.final at 3.11 is right. compat.py:157-174 gates on 3.11, the first release where final sets __final__.
  • No reference used any of the retitled headings.
  • The reviewer's own Sphinx -n build matches main exactly, warning for warning.

Found along the way, now #1045: a missing engine produces two EngineWarnings.

@JarryShaw JarryShaw added review: needs-changes Cross-review at the current head says changes are required; see the verdict comment and removed review: running A cross-review is in flight against the current head - no verdict yet labels Oct 5, 2026
…719)

- engines/3rdparty, engines/index: drop host-specific "measured on" figures and
  version-pinned verification logs, keep the rationale; correct the claim that
  every engine enforces its constraint via unsupported_reason (PyPCAP has no
  Python ceiling check); retitle a sentence-style heading
- extraction, interface/core, vendor/ipx, traceflow/index, pcapkit/index: drop
  "has since landed" / "now" / "was added" / attribution prose
- interface/index: add the PyPCAP, PCAP_CT, PyPCAPFile constants to the table
- utilities: tighten the v1.4.1 behaviour notes; typing.final shim gate is 3.11
- reassembly: merge duplicated RCVBT/RFC 815 paragraphs; drop "no longer"/"charged"
- fix heading typos (Miscellaneous, Definition, Extraction) and "parameters"

Sphinx -n warnings for these pages: 47 vs 47 on main, none new.
@JarryShaw
JarryShaw force-pushed the docs/719-autodoc-core branch from cdb7f69 to 1959303 Compare October 5, 2026 19:48
@JarryShaw JarryShaw added review: running A cross-review is in flight against the current head - no verdict yet and removed review: needs-changes Cross-review at the current head says changes are required; see the verdict comment labels Oct 5, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Cross-review verdict on 1959303a1: GOOD TO GO (ran on Sonnet).

Every claim in the new engines/index.rst sentence checks out against origin/main:

  • PyShark checks a 3.14 ceiling, then tshark (pyshark.py:126, :134-151).
  • PyPCAPFile checks only its 3.12 ceiling.
  • PCAP_CT checks for a system libpcap.
  • PyPCAP and PCAP_CT both call _pcap_backend.wrong_backend_reason.
  • PyPCAP's deliberate absence of a ceiling check, and the reason for it, match pypcap.py:146-151.

No other engine overrides unsupported_reason. The paragraph agrees with the version table and with the later bullet. The make test and coding-style boxes are now N/A with reasons.

Nits, not blocking: "a fall back" would read better as "a fallback". The source qualifies the refused build as hypothetical; the page does not.

@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 5, 2026
@JarryShaw
JarryShaw merged commit 8e80c1c into main Oct 5, 2026
10 of 11 checks passed
@JarryShaw
JarryShaw deleted the docs/719-autodoc-core branch October 5, 2026 20:07
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 5, 2026
@JarryShaw JarryShaw added this to the 1.5 milestone Oct 6, 2026
@JarryShaw JarryShaw moved this to Done in PyPCAPKit Oct 6, 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