You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 58fbca4
Browse filesBrowse the repository at this point in the historyBrowse files
docs(foundation): third whole-repo pass over foundation, toolkit, dumpkit, interface and utilities (#1103) (#1834)
* docs(foundation): third whole-repo pass over foundation, toolkit, dumpkit, 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
* docs(foundation): fix the review findings on the foundation pass (#1103)
- 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
* docs(foundation): resolve the Completion cross-references (#1103)
- 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
0 commit comments