Repository navigation
docs(protocols): tighten application, link and root protocol prose (#719) - #1039
Merged
Merged
Conversation
Owner
Author
|
Cross-review verdict on
Confirmed by probe on this head:
Found along the way, filed separately as #1041: HTTP/1 messages with no header fields cannot be parsed. |
) - Cut timed context (what used to happen, which issue changed it, "today", "still", measurement anecdotes) from protocol.py, http.py, httpv1.py, httpv2.py, ngap.py, ospf.py, l2tp.py, l2tpv2.py; keep the rationale and the rejected-option reasoning. - Fix prose that disagreed with the code: ARP._read_proto_resolve, _make_proto_resolve and _make_addr_resolve described returns that are not what they return; httpv2.unpack cited a struct.error path that FieldBase.length now converts to ProtocolError; dropped an http.py line reference. - Docstrings and comments only; AST identical to origin/main once docstrings are stripped.
JarryShaw
force-pushed
the
docs/719-protocols-app-link
branch
from
October 5, 2026 18:56
742261b to
4069a98
Compare
Owner
Author
|
Cross-review verdict on
All 14 files are AST-identical to |
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.
make testpasses, and a test case covers the change (prose only: existing modules for the slice,tests/projectandtests/test_docstring_contract.pypass, one module per process)What is the purpose of your pull request?
fixfeatperfrefactortestdocs— documentation onlycichoreDescription
Prose sweep (#719) for
pcapkit/protocols/application/,pcapkit/protocols/link/andprotocol.py. Cuts timed context and narrative, keeps rationale and rejected-option reasoning, and fixes prose that disagreed with code:ARP._read_proto_resolve,_make_proto_resolveand_make_addr_resolvereturns, and thehttpv2.unpacknote about astruct.errorpath thatFieldBase.lengthnow converts toProtocolError. TheProtocolBase.registerandLink.registerWarns:contracts are unchanged in meaning.Sphinx
-n, fresh dirs, branch vsorigin/main: 106 vs 106 warnings on these files after normalising paths and line numbers, 0 new.AST guard (docstrings stripped, compared with
origin/main):