Repository navigation
docs(tcp): name what the MPTCP and option makers raise; give Quick-Start rate its unit (#2235) - #2247
Merged
Merged
Conversation
…art rate its unit (#2235) TCP._make_mptcp_join raises ProtocolError on a flags combination that is none of SYN, SYN/ACK and ACK, and TCP._make_tcp_options passes on what its option makers raise, yet neither had a Raises section. Add one to each: ProtocolError for both, plus ProtocolNotImplemented for a named MPTCP subtype or alternate checksum algorithm not in its namespace. The TCP Quick-Start Response req_rate and the IPv4, HOPOPT and IPv6-Opts Quick-Start rate fields hold an int since #2167 but gave no unit. State that they are in kbps, 40 * 2 ** N or 0 for N = 0 (RFC 4782 Section 3.1), and add a versionchanged 1.5.0 for the float to int change, matching the FastOpenCookie note from the same fix. Docstring and #: comments only; the AST guard passes, so there is no fail-without-fix test.
JarryShaw
added
docs
Owner
Author
|
Review: GOOD TO GO at
|
JarryShaw
added
review: good-to-go
Owner
Author
|
Ready to merge at
|
Contributor
|
Coverage: 91.56% (unit tier, Python 3.15,
Per-file detail: the |
JarryShaw
removed
the
review: good-to-go
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 changeWhat is the purpose of your pull request?
docs— documentation onlyDescription
Closes #2235.
Raises:sections:TCP._make_mptcp_joinraisesProtocolErrorfor a flag combination other than SYN, SYN/ACK or ACK.TCP._make_tcp_optionsnames theProtocolErrors its option makers raise, plusProtocolNotImplementedfrom_make_indexfor an unknown MPTCP subtype or checksum algorithm name.QuickStartResponse.req_rateand the IPv4, HOPOPT and IPv6-Optsratefields state the unit, kbps (40 * 2 ** N, or 0 when N is 0), per RFC 4782 Section 3.1. Each gets aversionchanged:: 1.5.0noting that the field is anint, not afloat(fix(tcp): Quick-Start rate parses as float and a Fast Open cookie request as None, against their annotations #2167), matchingFastOpenCookie.#:comments only, with the AST guard OK on all 5 files.