Repository navigation
docs(protocols): sweep application, misc and the protocol base (#1103) - #1765
Conversation
Version directives (1.5.0), in module docstrings and on the pages: - versionchanged for the rebuild and construction-keyword changes on Application, FTP, HTTP/1.*, HTTP/2, PCAP, PCAP-NG and the base - versionadded/versionremoved for the OSPF and RARP move out of protocols.link and the CryptographicAuthentication rename - versionchanged on schema_final (@Final enforced) and Option's ns= Accuracy: - pack() builds from kwargs alone and replaces __header__; the _check_construction_keywords kwargs cover from_data too - "contains X only" fixed in protocol.py, httpv1 and pcapng - Engine's keyword is engine=; register() checks ProtocolBase; the beholder and Schema.get_payload refs name the defining modules - TLSKeyLabel directive cites issue #886, not PR #890 - timed wording ("currently", "no longer", "as before") removed Render: literals moved out of bold, a Note split by the injected rtype moved, a role broken over two lines joined, a duplicate automethod cut. Refs #1103
|
Verdict: GOOD TO GO at
|
|
Verdict: NEEDS CHANGES at |
|
Correction: this PR had already merged when I posted the note above, so nothing changes here. The revert of the |
…base (#1103) (#1785) 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
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
applicationslice. It follows the #719 rules: prose only, accuracy first, no churn and no timed context.Version directives (1.5.0), in module docstrings and on the pages:
Application, FTP, HTTP/1.*, HTTP/2, PCAP, PCAP-NG and the base
protocols.link and the CryptographicAuthentication rename
Accuracy:
_check_construction_keywords kwargs cover from_data too
beholder and Schema.get_payload refs name the defining modules
Render: literals moved out of bold, a Note split by the injected rtype
moved, a role broken over two lines joined, a duplicate automethod cut.
Checks:
.pyfile.tests/projectgives 930 passed and 1 skipped, and every test that reads the edited paths passes.Not covered here; a round-2 PR follows: the rest of httpv2.py, the short pcapng and pcapng-schema docstrings, and pcapkit/protocols/data/**, which no slice covered.
Refs #1103