Repository navigation
docs(protocols): sweep link and transport prose (#1103) - #1761
Merged
Merged
Conversation
Owner
Author
|
Verdict: GOOD TO GO at
|
Version directives, all 1.5.0 and naming the issue: - versionchanged on ARP, InARP, L2TP, VLAN, TCP and UDP. - versionadded on L2TPv2, C_Tag, S_Tag and SCTP. Accuracy: - Header tables use the data-model keys: ethernet.*, tcp.options, l2tp.version, and the tcp.flags.reserved row on the TCP page. - _read_mode_poc names the POC-permitted option; SACK typo fixed. - Timed wording dropped: "currently" (7), "as before" (2). Rendered output: - Dead cross-references now resolve: Protocol.* for ProtocolBase.*, Protocol.info, apptype.apptype.AppType, VLAN's C_Tag/S_Tag links. - Stray quote removed from the FastOpenCookie docstring. - TCP, SCTP, Link and Transport pages document the referenced helpers, schemas and hooks they were missing. Refs #1103
Contributor
|
Coverage: 89.59% (unit tier, Python 3.15,
Per-file detail: the |
JarryShaw
force-pushed
the
docs/1103-linktrans
branch
from
October 15, 2026 17:10
c8f49a3 to
97ed26c
Compare
Owner
Author
|
Verdict: GOOD TO GO at |
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 elseDescription
Part of #1103, the whole-repository prose sweep, for the
linktransslice. It follows the #719 rules: prose only, accuracy first, no churn and no timed context.Version directives, all 1.5.0 and naming the issue:
Accuracy:
l2tp.version, and the tcp.flags.reserved row on the TCP page.
Rendered output:
Protocol.info, apptype.apptype.AppType, VLAN's C_Tag/S_Tag links.
helpers, schemas and hooks they were missing.
Checks:
.py: code is identical once docstrings are blanked.tests/projectand every test that reads the edited paths pass.Not covered here; a round-2 PR follows: the autodoc lists of tcp.rst and sctp.rst (checked by script only), and pcapkit/protocols/data/link/** and data/transport/**.
Refs #1103