Repository navigation
docs(protocols): third whole-repo pass over link and transport (#1103) - #1833
Merged
Merged
Conversation
Counts: - reword the SCTP PPID and error-cause notes, the register_apptype note, the HTTP port comments, the L2TP dispatch prose, the MPTCP subtype comment and the nested_length docstring without counting Accuracy: - L2TP no longer says only one version exists: L2TPv3 and L2F exist, unimplemented - TCP Flags.urg is the flag, not the pointer; the option-list and unassigned-option docstrings say what they do; selectors document their FieldError - the L2TPv2 note points at the module page, not a missing measurement Directives: - versionchanged 1.5.0 on TCP.make and UDP.make for out-of-range ports (#758), and on UDP.make for total_length preceding payload (#1155) Rendering: - single-paragraph Returns on the MPTCP selectors, so no empty paragraph - autodoc no longer reads #: comments' leading phrases as types - drop the duplicate Flags stub on tcp.rst and repeated notes on l2tpv2.rst and s_tag.rst; move the L2TP class above its narrative - document the ARP schema fields and l2tp_payload_length Grammar: e.g./etc., register Warns and notes, reserved rows, __init__. Refs #1103
Owner
Author
|
Verdict: GOOD TO GO at
A combined clean Sphinx build of |
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 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 elseCounts:
the HTTP port comments, the L2TP dispatch prose, the MPTCP subtype
comment and the nested_length docstring without counting
Accuracy:
unimplemented
unassigned-option docstrings say what they do; selectors document
their FieldError
Directives:
(const(apptype): AppType.get() swallows the range guard and mints out-of-range ports #758), and on UDP.make for total_length preceding payload (design(protocols): should from_data keep declared lengths on truncated captures? #1155)
Rendering:
l2tpv2.rst and s_tag.rst; move the L2TP class above its narrative
Grammar: e.g./etc., register Warns and notes, reserved rows, init.
Non-prose check:
ast.dumpis unchanged once docstrings are blanked; any workflow, TOML or script edits are comment-only (parsed and compared). Narrow test runs are green (tests/projectand the tests that read edited files).Refs #1103