Skip to content

docs(internet): align IGMP alias and family docs with the id() ruling (#2512) - #2520

Merged
JarryShaw merged 1 commit into
mainfrom
docs/2512-igmp-doc-drift
Nov 1, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
docs/2512-igmp-doc-drift

Conversation

@JarryShaw

Copy link
Copy Markdown
Owner

What is the purpose of your pull request?

  • fix — corrects a defect
  • feat — adds a feature
  • perf — changes performance, not behaviour
  • refactor — changes neither behaviour nor performance
  • test — tests only
  • docs — documentation only
  • ci — workflows or build tooling
  • release — bumps the version or rolls up a distribution
  • chore — anything else
  • const — regenerates constant or registry tables, members keeping their numeric values

Description of your pull request and other information

Follow-up to #2518 (#2512): pre-existing IGMP doc drift that its cross-review found.

  • The IGMP.alias docstring and igmp.rst now match the code: IGMPv1 reports IGMP, not IGMPv1.
  • IGMPv3 is added to the Mermaid graph in protocols/index.rst, with its click target, and to ext.rst's IGMP family rows.
  • igmp.rst gains automethod:: id, so the conventions page's IGMP.id() reference resolves, and version now links.
  • pep.rst no longer lists IGMPv3 (feat(internet): implement IGMPv3 (group-record list) #2448) as pending.

A Sphinx -E build against the pinned docs requirements shows no new warnings. The doc-claims, internal-refs, roles, ambiguous-xref and docstring-contract tests pass.

…#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.
@JarryShaw JarryShaw added docs Pull requests that change documentation only (docs: subject prefix) review: running A cross-review is in flight against the current head - no verdict yet labels Nov 1, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Cross-review (Sonnet) at 282e427b7: GOOD TO GO. Each IGMP class's runtime alias matches the new text (IGMPv1 IGMP, v2 IGMPv2, v3 IGMPv3), and the igmp.py change is docstring-only by AST comparison. In a pinned-requirements Sphinx build, every Mermaid click target resolves, ext.rst's IGMP family spans all four rows, and every IGMP cross-reference on the conventions page links, including IGMP.id(). The six doc and IGMP test modules pass. Unverified: how the Mermaid graph renders in a browser.

@JarryShaw JarryShaw added review: good-to-go Cross-review at the current head says ready; CI state is separate and removed review: running A cross-review is in flight against the current head - no verdict yet labels Nov 1, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Nov 1, 2026
@JarryShaw
JarryShaw merged commit 73add05 into main Nov 1, 2026
59 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Nov 1, 2026
@JarryShaw
JarryShaw deleted the docs/2512-igmp-doc-drift branch November 1, 2026 07:14
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Nov 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Pull requests that change documentation only (docs: subject prefix)

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant