Repository navigation
docs(docs): fourth whole-repo pass over the non-API docs (#1103) - #1912
Merged
Merged
Conversation
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
added
docs
Owner
Author
|
GOOD TO GO at |
JarryShaw
added
review: good-to-go
4 of 13 tasks
JarryShaw
removed
the
review: good-to-go
JarryShaw
added a commit
that referenced
this pull request
Oct 19, 2026
…mpkit, interface and utilities (#1103) (#1911) * docs(foundation): fourth whole-repo pass over foundation, toolkit, dumpkit, interface and utilities (#1103) Accuracy: - Dumper's registration example passes ext by keyword; register_dumper takes it keyword-only, so the positional form raised TypeError. - The strict -> reasm_strict rename and TraceFlow.register removal directives name 1.1.1, whose changelog records the 1.1.1.post2 change. Cross-references: - sys.excepthook and threading.excepthook are functions, so they use :func: and resolve through intersphinx. - The IP reassembly page documents _detect_conflicts, which the IP data model and the IPv4 and IPv6 pages link to. - The exceptions page documents _CaughtByCaller and says how it makes an error quiet. Wording: - "c.f." becomes "cf.", and the redundant "and etc." is dropped. - A list item in the PCAP-NG engine's read_frame ends with a semicolon. Refs #1103 * docs(foundation): address #1911 review (#1103) - Bring the pcapkit.interface docs page in line with the module docstring this PR rewords, dropping "and etc". * docs(interface): match the #1912 page wording and leave its rst to #1912 (#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. * docs: mark post-release changes with their post-release (#1103) - Mark the strict/reasm_strict rename on Extractor and extract(), and the removal of TraceFlowBase.register, with 1.1.1.post2, where they first shipped, rather than the parent 1.1.1. - Mark the OptionType int conversion on the const pcapng page with 1.1.0.post1 rather than 1.1.0, and move the #1884 guard's pin with it.
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
1 participant
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.
Please follow the guide below
You will be asked some questions, please read them carefully and answer honestly
Put an
xinto all the boxes [ ] relevant to your pull request (like that [x])Use Preview tab to see how your pull request will actually look like
Searched for similar pull requests
Followed the coding style (
make pylint,make mypy,make isort)make testpasses, and a test case covers the change. Narrow runs only, listed below.Added a changelog entry under
docs/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?
Tick the commit type your subject line carries.
fix— corrects a defectfeat— adds a featureperf— changes performance, not behaviourrefactor— changes neither behaviour nor performancetest— tests onlydocs— documentation onlyci— workflows or build toolingrelease— bumps the version or rolls up a distributionchore— anything elseThe fourth whole-repo prose pass of #1103, over the hand-written docs pages, every index and toctree. It changes prose only: every changed
.pyfile'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:
exception hooks; it no longer sets sys.tracebacklimit
the one checksum verifier
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