Repository navigation
docs(protocols): third whole-repo pass over application, misc and the protocol base (#1103) - #1835
Merged
Merged
Conversation
… protocol base (#1103) Counts: - Drop counted numbers from the NGAP, HTTP, HTTP/2, PCAP, PCAP-NG, schema base and protocol base docstrings and pages; a spec total used as a coverage claim becomes count-free, and measurements stay. Rendered output: - The OSPF and DSB selectors' Returns is one paragraph, not a list behind an empty paragraph, and the DSB one states what the selector returns. - NGAP's conversion table keeps its last row whole, and the class entry sits above the narrative sections. - Document the root data model and PCAPNG.packet, reattach doc comments a NOTE had cut off, and keep the stdlib enum hook off the enum pages. - Fix dead or under-qualified cross-references, split napoleon types in the Protocol and Raw constructors, and doc-comment types that rendered raw aliases. Accuracy and wording: - RARP and ARP share a frame format, not an EtherType; readers return parsed data; __index__ raises as documented; grammar and spelling fixes; no timed wording in the TLSKeyLabel removal note. Directives: - versionchanged on OSPF and HTTP/2 make() for a parameter inserted before existing ones; the OSPF and RARP removal notes name the package-level names that went. Refs #1103
Owner
Author
|
Verdict: NEEDS CHANGES at
Two blocking defects, both re-checked:
A worker is adding a fix commit to this branch. |
- protocol: the out-of-band Note names only the keywords __init__ pops; packet is read and forwarded, not consumed - conf: skip the enum machinery's _generate_next_value_ ahead of napoleon, which re-included it; drop the per-page exclude-members that could not - tests: pin the hook, its priority, and _missing_ staying documented - ospf: the removal note also names OSPF_CrytographicAuthentication - http, ngap: a full sentence for the Note lead-in; name the cache states - pcapng: "Drops count", the PCAP-NG field's name Refs #1103
Owner
Author
|
Verdict: GOOD TO GO at
|
Contributor
|
Coverage: 90.05% (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.
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 elseCounts:
base and protocol base docstrings and pages; a spec total used as a
coverage claim becomes count-free, and measurements stay.
Rendered output:
empty paragraph, and the DSB one states what the selector returns.
above the narrative sections.
NOTE had cut off, and keep the stdlib enum hook off the enum pages.
Protocol and Raw constructors, and doc-comment types that rendered raw
aliases.
Accuracy and wording:
data; index raises as documented; grammar and spelling fixes; no
timed wording in the TLSKeyLabel removal note.
Directives:
existing ones; the OSPF and RARP removal notes name the package-level
names that went.
Non-prose check:
ast.dumpis unchanged on every.pyfile once docstrings are blanked. The OSPF and HTTP/2make()directives are checked against v1.4.1: both signatures move an existing positional parameter. Narrow test runs are green.Refs #1103