Repository navigation
docs(protocols): second pass over application, misc and the protocol base (#1103) - #1785
Merged
Merged
Conversation
…base (#1103) protocol.rst: - give ProtocolBase targets for every member Protocol documents, as grouped stubs linking to the Protocol entries, so the ProtocolBase.* references across the tree resolve; document its own __init_subclass__, and __keywords__ and __length_hint__ under Protocol - drop the FRAME_LAYER_LIMIT versionremoved, a beta-only name, here and in protocol.py Accuracy: - register() names the public Protocol class, as ruled on #1016: put back the wording #1765 changed to ProtocolBase in protocol.py, PCAP and PCAP-NG - HTTP/2 makers: the settings types accepted and the type check otherwise; sid_dep sets PRIORITY - PCAP-NG: EPB timestamps are not in seconds; SPB's interface, timestamp and epoch are fixed; opt_endofopt and nrb_record_end are moved to the end, not ignored; NWK, not NKW - PCAP ts_usec holds nanoseconds in a nanosecond-resolution file Refs #1103
Owner
Author
|
Verdict: GOOD TO GO 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.
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 elseSummary
#1103 round 2: the files phase 1 left unread, plus the phase-1 reviewers' follow-ups.
protocol.rst:
grouped stubs linking to the Protocol entries, so the ProtocolBase.*
references across the tree resolve; document its own
init_subclass, and keywords and length_hint under Protocol
in protocol.py
Accuracy:
back the wording docs(protocols): sweep application, misc and the protocol base (#1103) #1765 changed to ProtocolBase in protocol.py, PCAP
and PCAP-NG
otherwise; sid_dep sets PRIORITY
and epoch are fixed; opt_endofopt and nrb_record_end are moved to the
end, not ignored; NWK, not NKW
Refs #1103