Repository navigation
docs(protocols): fourth whole-repo pass over internet (#1103) - #1907
Conversation
Rendering: - Drop the duplicated RPL, MPL and DFF flag stubs on the HOPOPT and IPv6-Opts pages, and the type prefixes on the registry comments that rendered a second, unlinked Type field. - Point load_cryptography at InvalidTag rather than an unresolved module. Reachability: - Carry the IPv6-Ext length rules, entry paths and overrun guard on its page, and point the docstrings at those sections rather than at the unrendered module docstring; likewise ESP's algorithm support. - List the per-suite ESP parameters the support tables left out. Accuracy: - Rebuild the IPv6-Ext exception table so its rows render, and title the page IPv6-Ext after the alias. - Say ESP's next is None only while its payload stays opaque. - Fill the blank IPv4 and ESP table cells, describe HIP's fixed bits as bits, and correct the PDM field acronyms. - Drop the directive on beta-only PMIPv6Timestamp and the page-level copy of NTPTimestamp's, which its class docstring already renders. Wording: "the extractor", "construction arguments", "see" for "c.f.", and spec totals worded count-free. Refs #1103
|
NEEDS CHANGES at |
- jumbogram_error: restore "four errors", the count RFC 2675 section 3 lists for a node that understands the Jumbo Payload option. - LocalizedRoutingAcknowledgmentMessage: restore "three status values", the count RFC 6705 section 10.2 defines. - Spec quantities are exempt from the no-counted-numbers rule.
|
GOOD TO GO at |
|
Coverage: 90.07% (unit tier, Python 3.15,
Per-file detail: the |
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 elseThe fourth whole-repo prose pass of #1103, over the internet protocols. It changes prose only: every changed
.pyfile's AST is unchanged once string expressions are blanked, except where a docstring is added or vendor template text is edited together with its generated const file.Rendering:
IPv6-Opts pages, and the type prefixes on the registry comments that
rendered a second, unlinked Type field.
Reachability:
page, and point the docstrings at those sections rather than at the
unrendered module docstring; likewise ESP's algorithm support.
Accuracy:
page IPv6-Ext after the alias.
bits, and correct the PDM field acronyms.
of NTPTimestamp's, which its class docstring already renders.
Wording: "the extractor", "construction arguments", "see" for "c.f.", and
spec totals worded count-free.
Refs #1103