Repository navigation
docs(protocols): third whole-repo pass over internet (#1103) - #1836
Merged
Merged
Conversation
Directives - versionchanged on the AH, IPv4, IPv6, IPv6-Frag, IPv6-Route, IPX, MH and HIP make() signatures that insert a defaulted parameter ahead of existing positional ones. - OrderedMultiDict to OrderedMultiInfo on the HOPOPT, IPv6-Opts, HIP, IPv4, MH message and CGA data models and on TSOption.timestamp; the MPL seed_id, PUZZLE lifetime and BRA interval types; the schema trailer fields and the reserved fields now read as integers. Counts - Drop counted subclasses, call sites, registry entries, subtypes and list items from the internet docstrings and pages. Rendering - Fix the IPv6-Ext table continuation and class heading, the positional-arguments sections, the selector Returns lead-ins, the attribute comments autodoc split as types, stray rtype lines and an unresolved private-helper reference. Accuracy - Correct the IPv6-Ext make() note, the HIP length checks, the IPX socket field, the options-length notes and the table name cells. Refs #1103
Owner
Author
|
Verdict: GOOD TO GO at
No count was added, and the ASTs are identical with docstrings blanked. A combined clean Sphinx build of Its first line read NEEDS CHANGES, but it listed no required change. The flagged items are polish and are held for the next pass:
|
Contributor
|
Coverage: 90.05% (unit tier, Python 3.15,
Per-file detail: the |
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 elseDirectives
and HIP make() signatures that insert a defaulted parameter ahead of
existing positional ones.
IPv4, MH message and CGA data models and on TSOption.timestamp; the
MPL seed_id, PUZZLE lifetime and BRA interval types; the schema
trailer fields and the reserved fields now read as integers.
Counts
list items from the internet docstrings and pages.
Rendering
positional-arguments sections, the selector Returns lead-ins, the
attribute comments autodoc split as types, stray rtype lines and an
unresolved private-helper reference.
Accuracy
socket field, the options-length notes and the table name cells.
Non-prose check:
ast.dumpis unchanged on every.pyfile once docstrings are blanked. Theversionchangedon eachmake()is checked against v1.4.1: every one of those signatures moves an existing positional parameter. Narrow test runs are green.Refs #1103