Repository navigation
docs(toolkit): drop agreement claims from adapter docstrings (#1708) - #1741
Merged
Merged
Conversation
Third-party engines are best effort (#1687), so the docstrings and comments stop saying an adapter does what another engine does: - toolkit/dpkt: six clauses ("as the default engine hands over", "as every engine's adapters do", "in every other engine", ...) - toolkit/pyshark: the epoch, tunnel, fixed-header and SPB notes - engines/dpkt: the SPB, Loopback, packet-block and raw-fallback notes now say what the engine does - engines/pyshark: packet records are counted by the engine itself - engines/pypcapfile: a zero-length record no longer cites the default engine - extraction: record_header no longer compares to the built-in engines - reassembly/ip: a Total Length of 0 no longer claims every adapter tests/project/test_no_engine_agreement_prose_1708_unit.py scans pcapkit/ and docs/source/ (changelog excluded) for those shapes, with whitespace, comment markers and reST markup normalised. It fails on d067010 with 19 hits and passes here; two hits in files #1726 owns are listed as pending. Docstring- and comment-only: the AST with docstrings stripped is identical for all seven modules. Refs #1708
Owner
Author
|
Verdict: GOOD TO GO at
|
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.
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 elseRefs #1708 (phase 3b). This PR removes the agreement claims from the adapter docstrings, following the best-effort ruling on #1687. The docs pages were fixed in
d06701064.foundation/engines/{dpkt,pypcapfile,pyshark}.py,foundation/extraction.py,toolkit/{dpkt,pyshark}.pyandfoundation/reassembly/ip.py. Every replacement claim was checked against the code, for example the Loopback families{2, 24, 28, 30}andlocalcontext(prec=64).main. Four paragraphs are reflowed (whitespace only).tests/project/test_no_engine_agreement_prose_1708_unit.pyscanspcapkit/**/*.pyanddocs/**, with reST markup stripped first. It fails onmainwith 19 hits and passes here. Legitimate uses such aspypcap-parityand the pcap-ct comparisons stay clean. Two hits sit in files the open feat(utilities): one config module for the tunable limits (PCAPKIT_* environment variables), and one home per duplicated protocol constant #1726 work owns and are allowlisted with that reason.