Repository navigation
docs(foundation): third whole-repo pass over foundation, toolkit, dumpkit, interface and utilities (#1103) - #1834
Merged
Merged
Conversation
…pkit, interface and utilities (#1103) Cross-references: - point TraceFlow.finish/index/dump, register_tcp/udp/sctp, Reassembly.expire and the class name properties at their documented targets; qualify Completion, Deferred, Index, Extractor and LinkType so they resolve from any module - document the per-protocol __timeout__ and TCP __window__ hooks, and the public dpkt timestamp and buffer helpers the adapters cite Rendered output: - move each toolkit adapter's reassembly condition into the body and keep Returns to one paragraph, which drops the empty paragraph Returns opened with - reword first lines napoleon split as a type, drop a python: prefix and a raw type prefix, hide the PyShark table reprs, drop a duplicated BufferID entry Counts: remove counted numbers from living prose; spec quantities, constants and measurements stay Accuracy and wording: Raises and Warns for TraceFlowBase.register_dumper, the __output__ value shape, the MH registrar parameters, trace()'s protocol, the IPv6 overlap note, the traceflow packet shape, make_dumper's return, the PCAP-NG Context summary, timed "this tree" wording, and typos and grammar Refs #1103
Owner
Author
|
Verdict: NEEDS CHANGES at
Blocking, all re-checked:
A worker is adding a fix commit to this branch. |
- EnumKeyError: restore the predicate a count removal dropped; re-wrap - config.rst: vendor.default reads and documents the vendor variables - Document Completion so the references to its members resolve - Point the __output__ references at TraceFlow, where it is documented - packet2timestamp: a nanosecond file yields a DecimalTimestamp - Render RecordTimestamp's attribute docs with :members: - Name the PyPCAP/PCAP_CT pair rather than count it; "each channel" - Re-wrap over-long lines in exceptions.py, reassembly.py and data.py Refs #1103
Owner
Author
|
Verdict: NEEDS CHANGES at
Rendering
A worker is adding a commit. |
- Retarget the TIMEOUT comment's timeout link to Reassembly.timeout - Spell compat's StrEnum, aenum and __str__ as literals, since none of them is a documented object - Qualify the TLSKeyLabel isinstance claim to Python 3.11 and later, where compat.StrEnum is the stdlib class rather than aenum's - EnumKeyError: link Method and spell its private get as a literal Refs #1103
Owner
Author
|
Verdict: GOOD TO GO at
|
Contributor
|
Coverage: 90.05% (unit tier, Python 3.15,
Per-file detail: the |
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 elseCross-references:
the class name properties at their documented targets; qualify Completion,
Deferred, Index, Extractor and LinkType so they resolve from any module
dpkt timestamp and buffer helpers the adapters cite
Rendered output:
to one paragraph, which drops the empty paragraph Returns opened with
type prefix, hide the PyShark table reprs, drop a duplicated BufferID entry
Counts: remove counted numbers from living prose; spec quantities, constants and
measurements stay
Accuracy and wording: Raises and Warns for TraceFlowBase.register_dumper, the
output value shape, the MH registrar parameters, trace()'s protocol, the IPv6
overlap note, the traceflow packet shape, make_dumper's return, the PCAP-NG
Context summary, timed "this tree" wording, and typos and grammar
Non-prose check:
ast.dumpis unchanged on every.pyfile once docstrings are blanked. Narrow test runs are green.Refs #1103