Repository navigation
docs(internet): align IGMP alias and family docs with the id() ruling (#2512) - #2520
Merged
Merged
Conversation
…#2512) - IGMP.alias docstring and igmp.rst: IGMPv1's alias is 'IGMP', not 'IGMPv1'. - igmp.rst documents IGMP.id(), so the family-grouping page's reference resolves; its alias and version references now name the class. - Protocols hierarchy graph (with click target) and ext.rst family table list IGMPv3. - Roadmap no longer reads IGMPv3 (#2448) as pending.
Owner
Author
|
Cross-review (Sonnet) 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.
make pylint,make mypy,make isort)make testpasses, and a test case covers the changeWhat is the purpose of your pull request?
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 elseconst— regenerates constant or registry tables, members keeping their numeric valuesDescription of your pull request and other information
Follow-up to #2518 (#2512): pre-existing IGMP doc drift that its cross-review found.
IGMP.aliasdocstring andigmp.rstnow match the code: IGMPv1 reportsIGMP, notIGMPv1.protocols/index.rst, with its click target, and toext.rst's IGMP family rows.igmp.rstgainsautomethod:: id, so the conventions page'sIGMP.id()reference resolves, andversionnow links.pep.rstno longer lists IGMPv3 (feat(internet): implement IGMPv3 (group-record list) #2448) as pending.A Sphinx
-Ebuild against the pinned docs requirements shows no new warnings. The doc-claims, internal-refs, roles, ambiguous-xref and docstring-contract tests pass.