Repository navigation
docs(protocols): fifth whole-repo pass over link and transport protocols (#1103) - #2152
Merged
Merged
Conversation
…ols (#1103) - TCP/SCTP option, chunk, parameter and cause registries: document that a non-string value is a (parser, constructor) pair and name the fallback methods, in the registry comments and the register_* meth arguments. - TCP __proto__ comment: HTTP dispatch trial-parses as a last resort; UDP binds the same class, not a proxy. - ARP._make_proto_resolve: FieldValueError also covers an invalid or wrong-version IP address. - L2TP: drop the inaccurate HTTP/3-QUIC analogy for L2F/L2TPv1. - Link._read_protos returns an EtherType, not an internet-layer enum. - TODO grammar in the link and transport package inits.
Owner
Author
|
GOOD TO GO at
|
This was referenced Oct 25, 2026
Merged
Contributor
|
Coverage: 91.55% (unit tier, Python 3.15,
Per-file detail: the |
Owner
Author
|
Ready to merge at
|
5 tasks done
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; narrow selections below)What is the purpose of your pull request?
docs— documentation onlyDescription
Part of #1103, round 5: the link and transport slice, on
main4c3d30163. This PR changes prose only; the AST with docstrings stripped is identical on all 7 changed.pyfiles.TCP.__option__,__mp_option__, andSCTP.__chunk__/__parameter__/__cause__claimed a missing method name makes the value parse by itself. In fact a missing name falls back to*_donone/*_unknown, and a non-string value is a(parser, constructor)tuple. Theregister_*metharguments now say so too.TCP.__proto__: the comment said HTTP dispatch avoids a trial parse, butHTTP._guess_versiontrial-parses as a last resort. It also said UDP binds a proxy; UDP binds the sameHTTPclass.ARP._make_proto_resolve:FieldValueErroris raised for invalid and wrong-version addresses, not only for bools (checked at runtime).l2tp.rst: dropped the wrong HTTP/3–QUIC analogy for L2F/L2TPv1.Link._read_protosreturns an EtherType.tests/project/test_docs_*plustest_conventions_doc_claims: 94 passed.tests/protocols/{link,transport}passes once the fixture captures are generated.