Repository navigation
docs(tests): correct stale claims in test docstrings and comments (#1103) - #1764
Merged
Merged
Conversation
) Prose only: the AST of every changed module, string expression statements blanked, is identical to origin/main's. - Timed context: "this PR" names its PR (#755, #802, #836, #854, #869, #874, #922, #926); "today", "as of writing", "right now", "until now" and a "now installs" are anchored or dropped. - Stale state: closed issues no longer read as open or in flight (#576, #651/#664, #674, #527, #531), and the minting, KNOWN_DEFECTS, vendor-depth and MPTCP-parse narratives are put in the past tense where later changes retired them. - Moved or renamed names: beholder's home, HTTP._read_http_header, PCAPNGSectionRuleTests, test_new_engine_parity_runtime, and the scapy cast that #1652 removed. - Line references: about 50 file:line pointers into pcapkit/, pyproject.toml, Pipfile and sibling tests re-measured. - Counts re-derived: raise targets and nested defs in test_docstring_contract, and the four returned nested defs it names. - A pytest-subtests claim corrected to pytest's own reporting. Refs #1103
Owner
Author
|
Verdict: GOOD TO GO at
|
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
testsslice. It follows the #719 rules: prose only, accuracy first, no churn and no timed context.Prose only: the AST of every changed module, string expression
statements blanked, is identical to origin/main's.
fix(const,vendor): bring 8 bespoke registries onto EnumRegistry, stop them minting #869, fix(const,vendor): bring the AppType family onto EnumRegistry, stop it minting (#860) #874, refactor(corekit): house all four sentinels in one shared module (#911) #922, fix(vendor): source ExtensionHeader from the extension-header registry, not the protocol-numbers flag (#925) #926); "today", "as of writing", "right now",
"until now" and a "now installs" are anchored or dropped.
(_make_mptcp_*/_read_mptcp_* length arithmetic is wrong at six more sites beyond MP_CAPABLE #576, HIP parameter padding aligns the contents, not the record, so every parameter pcapkit emits is 4 (mod 8) octets #651/fix(hip): pad HIP parameters to the record length RFC 7401 gives, not the contents (#651) #664, tests/_support.py leaves bare stub modules in sys.modules, so tests/corekit + tests/project in one process fails three test_public_api tests #674, fix(protocols): repair __all__ entries that name nothing, and guard the class #527, fix(vendor): make the handover_initiate_status crawler reachable (release blocker for
make vendor) #531), and the minting, KNOWN_DEFECTS,vendor-depth and MPTCP-parse narratives are put in the past tense
where later changes retired them.
PCAPNGSectionRuleTests, test_new_engine_parity_runtime, and the
scapy cast that fix(toolkit): scapy reads IP and TCP only in layers the default engine dissects (#1635, #1636) #1652 removed.
pyproject.toml, Pipfile and sibling tests re-measured.
test_docstring_contract, and the four returned nested defs it names.
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: function, method and class docstrings and inline comments (about 2.3 MB), starting with the largest files.
Refs #1103