Repository navigation
docs(foundation): add 1.5.0 version directives and fix stale prose (#1103) - #1763
Merged
Merged
Conversation
…1103) Version directives (38, all 1.5.0, citing issues rather than PRs): - versionchanged on Extractor, extract(), reassemble(), trace() and follow_tcp_stream() for the new parameters, timeout and tracing mode; on Engine, Reassembly, TraceFlow and Dumper for opt-in registration; on the IP, IPv6 and TCP reassemblers, make_dumper, PCAPIO, register_apptype, register_mh_extension, the dpkt reassembly adapters and pyshark tcp_traceflow. - logging, warnings and BaseError: import-time handler, one report per channel, silent quiet errors; three "up to v1.4.1" page admonitions become the matching directives. - versionadded on HoleDescriptor, Deferred, EnumKeyError and four logging functions; versionremoved for HoleDiscriptor, utilities.decorators and utilities.warnings.DEVMODE. Accuracy: traceflow TCP drops *args/**kwargs it does not take; return types and reassemble()'s strict match the code; follow_tcp_stream's PyShark note; a PR citation becomes its issue. Render: raw ``literals`` in two literal blocks, unresolved FileNotFound references, a duplicate BufferID entry. Prose: timed wording on the logging pages; grammar in the reassembly and IP docstrings. Refs #1103
Owner
Author
|
Verdict: GOOD TO GO at
|
Contributor
|
Coverage: 89.59% (unit tier, Python 3.15,
Per-file detail: the |
4 of 13 tasks
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 elseDescription
Part of #1103, the whole-repository prose sweep, for the
foundationslice. It follows the #719 rules: prose only, accuracy first, no churn and no timed context.Version directives (38, all 1.5.0, citing issues rather than PRs):
follow_tcp_stream() for the new parameters, timeout and tracing mode;
on Engine, Reassembly, TraceFlow and Dumper for opt-in registration;
on the IP, IPv6 and TCP reassemblers, make_dumper, PCAPIO,
register_apptype, register_mh_extension, the dpkt reassembly adapters
and pyshark tcp_traceflow.
channel, silent quiet errors; three "up to v1.4.1" page admonitions
become the matching directives.
functions; versionremoved for HoleDiscriptor, utilities.decorators and
utilities.warnings.DEVMODE.
Accuracy: traceflow TCP drops *args/**kwargs it does not take; return
types and reassemble()'s strict match the code; follow_tcp_stream's
PyShark note; a PR citation becomes its issue.
Render: raw
literalsin two literal blocks, unresolved FileNotFoundreferences, a duplicate BufferID entry. Prose: timed wording on the
logging pages; grammar in the reassembly and IP docstrings.
Checks:
.py: code is identical once docstrings are blanked.tests/projectand every test that reads the edited paths pass.Not covered here; a round-2 PR follows: the engine and toolkit bodies, plus the parts of reassembly, traceflow, registry and utilities that were only partly read.
Refs #1103