Repository navigation
docs(autodoc): cut timed context from the non-protocol autodoc pages (#719) - #1043
Merged
Merged
Conversation
Owner
Author
|
Cross-review verdict on
Confirmed:
Found along the way, now #1045: a missing engine produces two |
…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
force-pushed
the
docs/719-autodoc-core
branch
from
October 5, 2026 19:48
cdb7f69 to
1959303
Compare
Owner
Author
|
Cross-review verdict on Every claim in the new
No other engine overrides Nits, not blocking: "a fall back" would read better as "a fallback". The source qualifies the refused build as hypothetical; the page does not. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
make pylint,make mypy,make isort) — N/A,.rst-only diffmake testpasses, and a test case covers the change — N/A, docs only;tests/projectpassesdocs/source/changelog/and regeneratedCHANGELOG.md, if the change is user-visible — N/A — centralised in docs(changelog): shared 1.5.0 changelog — long-lived, merges last (#610, #616, #617, #618, #620) #657What is the purpose of your pull request?
docs— documentation onlyDescription of your pull request and other information
Slice of #719:
docs/source/pcapkit/**exceptprotocols/(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.finalgate 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, mostconst/andvendor/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 -nfresh dirs, branch vs main, slice warnings 47 vs 47, none new (1301 vs 1301 total).tests/project274 passed.