Repository navigation
docs(protocols): second-round pass over the link, misc, transport and root protocol prose (#719) - #1087
Merged
Conversation
… root protocol prose (#719) Correct claims the code contradicts: the Ethernet and VLAN field-offset tables, the TCP table's parsed `tcp.flags.ns` row, the PCAP-NG `pack_flags`/`pack_hash` method references, `unquote`'s default `errors`, the `__repr__`/`__str__` examples, `_read_mptcp_join`'s Raises condition, the `isb_usrdeliv` argument, `Transport.register`'s `protocol` argument, the "values are tuples" registry comments, and the "every non-raising `__index__`" claim in L2TPv2. Cut timed context in L2TPv2, C_Tag and the PCAP frame-length note; fix typos and re-case the L2TP module headings. Docstrings and comments only; the AST guard is clean for every file.
Owner
Author
|
Cross-review verdict on
Nit, not raised by this PR: UNVERIFIED: no Sphinx run, and no standalone PCAP-NG |
Contributor
|
Coverage: 88.74% (unit tier, Python 3.14,
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 changeAdded 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?
fix— corrects a defectfeat— adds a featureperf— changes performance, not behaviourrefactor— changes neither behaviour nor performancetest— tests onlydocs— documentation onlyci— workflows or build toolingchore— anything elseDescription of your pull request and other information
Second-round #719 pass over
pcapkit/protocols/{link,misc,transport}/,protocols/__init__.pyandprotocols/protocol.py. Only prose the code contradicts, timed context, typos and broken references changed; 14 of 31 files touched.tcp.flags.ns; PCAP-NGpack_flags/pack_hashrows named theepb_*methods;unquote's defaulterrorsis'replace', not'strict';__repr__/__str__examples; MP_JOINRaises:;isb_usrdelivargument;Transport.register'sprotocol; "values are tuples" registry comments; L2TPv2's "every non-raising__index__" (PCAPFrame/PCAPNG return a frame number).version, dispatch comment),C_Tag.id, the PCAP frame-length commit history.Checks: AST guard below; Sphinx
-non fresh output dirs, 136 warnings for these files on branch and onmain, none new;tests/project379 passed;tests/test_docstring_contract.pyand 27 slice modules (one per process) pass. Lint not run.pcapkit/protocols/link/__init__.pypcapkit/protocols/link/arp.pypcapkit/protocols/link/c_tag.pypcapkit/protocols/link/ethernet.pypcapkit/protocols/link/l2tp.pypcapkit/protocols/link/l2tpv2.pypcapkit/protocols/link/vlan.pypcapkit/protocols/misc/pcap/frame.pypcapkit/protocols/misc/pcap/header.pypcapkit/protocols/misc/pcapng.pypcapkit/protocols/protocol.pypcapkit/protocols/transport/__init__.pypcapkit/protocols/transport/tcp.pypcapkit/protocols/transport/transport.py