Repository navigation
docs(foundation): sixth whole-repo pass over foundation, utilities and toolkit (#1103) - #2211
Merged
Merged
Conversation
Prose only, across foundation, toolkit, interface, dumpkit and utilities:
- correct stale claims: Extractor._open_output names the version field the
PCAP engine passes; TCP._finalise and a TCP.trace comment name finish(),
not submit(), as the end-of-capture finaliser.
- rewrite change-relative narrative ("no longer", "was before", a sha used
as a before-marker, "keeps catching", "must not go back to") as timeless
statements, and drop timed context ("a current interpreter", "yet").
- fix grammar in the exceptions/warnings module openings and in
register_dumper's "registries".
AST guard OK; docs, conventions and nearest unit tests pass.
Owner
Author
|
Review: GOOD TO GO at
|
Owner
Author
|
Ready to merge at
|
Contributor
|
Coverage: 91.56% (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.
make testpasses, and a test case covers the changeWhat is the purpose of your pull request?
docs— documentation onlyDescription
Part of #1103, round 6: the sixth whole-repo prose pass over
pcapkit/foundation/,utilities/,toolkit/,interface/,dumpkit/and their API pages.Extractor._open_outputlists theversionfield the PCAP engine passes.finish(), notsubmit()._finalisealso runs on a FIN when tracing one direction._check_code, so it is unchanged.utilities.exceptionsandutilities.warnings, in both the.pyand the.rst. "registry" becomes "registries" inregister_dumper.main.