Repository navigation
docs(foundation): seventh whole-repo pass over foundation, utilities, interface, toolkit and dumpkit (#1103) - #2261
Merged
Merged
Conversation
Owner
Author
|
Review: GOOD TO GO at
|
… interface, toolkit and dumpkit (#1103) Full read of pcapkit/foundation, utilities, interface, toolkit, dumpkit, the top-level package and their API pages. - extraction/engines/registry: Extractor.run warns nothing itself; context engines; EngineBase.name works at class level; register_apptype Raises; magic_number documented; engine gap table; pcap-ct attributes. - reassembly/traceflow: RFC 791 pseudocode nesting and departures; RFC 9293 sections 3.10.8 and 3.5.3; expire, Datagram, Deferred and submit notes; name/protocol class-level Notes; typos. - utilities/interface: engine constants, option length widths, DEVMODE vs VERBOSE, ConfigWarning, env var truthy values; never-released config path. - toolkit/dumpkit: render_enum example, tree newline wrapping, PCAPIO note, dpkt reassembly notes checked against dpkt 1.9.8.
JarryShaw
force-pushed
the
docs/1103-r7-foundation-pr
branch
from
October 26, 2026 19:46
f60021a to
355a692
Compare
Owner
Author
|
CI fix 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.
make testpasses, and a test case covers the changeWhat is the purpose of your pull request?
docs— documentation onlyDescription
Part of #1103, round 7. A full read of
pcapkit/foundation,utilities,interface,toolkit,dumpkit, the top-level package and their API pages. Prose only: the AST guard is identical on all 20.pyfiles.Extractor.runemits noEngineWarningof its own, since__init__does.contextengines are named correctly.EngineBase.nameworks at class level.register_apptyperaises during the call.magic_numbergets anautoproperty, and the PyShark gap row liststrace_analyse.expire,Datagram,Deferredandsubmitnotes are corrected.name/protocolNotes now say the values are available at class level.PCAPKitis not an__engine__key.warn()reads VERBOSE; DEVMODE routes records.render_enumexample (Flags(15)),tree's 40-character newline rule, and the dpkt reassembly notes, checked against dpkt 1.9.8.tests/foundation/523 passed,tests/utilities/158,tests/interface/35,tests/toolkit/204,tests/dumpkit/77; docs, docstring-contract and convention tests pass.