Skip to content

docs(tests): drop never-released names (IPv6_GenericExt and helpers) - #2221

Merged
JarryShaw merged 1 commit into
mainfrom
docs/drop-unreleased-ipv6-genericext
Oct 26, 2026
Merged

JarryShaw merged 1 commit into
mainfrom
docs/drop-unreleased-ipv6-genericext

Conversation

@JarryShaw

@JarryShaw JarryShaw commented Oct 26, 2026 •

Copy link
Copy Markdown
Owner

What is the purpose of your pull request?

  • docs — documentation only

Description

Per the owner's ruling, IPv6_GenericExt shipped in no release, beta or final, so neither the docs nor the tests need to mention it. A moved name keeping no alias is already the general rule.

  • Page: removes the section "The Retired IPv6_GenericExt Name" from contributing/conventions/extension-header-subclassing.rst. Nothing linked to it.
  • Tests: removes RetiredNameTests from tests/project/test_conventions_doc_claims.py, along with its docstring bullet and the sibling docstrings that pointed at it. IPv6_Ext is still exercised by test_ipv6_ext_unit.py.
  • Grep: git grep GenericExt returns nothing.
  • Tests run: test_conventions_doc_claims, test_docs_*, test_ipv6_ext_unit and the docstring contract give 139 passed.
  • Three private test-only names, also absent from every release tag (the owner extended the ruling to them):
    • _PeekableStream: dropped from test_io_stream_proxies_1516_unit's docstring.
    • _TCPSegment: dropped from test_pcap_tcp_segment_public_1570_unit's docstring and from its hasattr loop. The _tcp_segment checks stay.
    • _can_seek: test_can_seek_is_exported_and_the_private_name_is_gone becomes test_can_seek_is_exported. The absence assertion is gone, and the __all__ check stays.
  • Grep: git grep -nw -e _PeekableStream -e _TCPSegment -e _can_seek returns nothing.
  • Tests run: the three files plus conventions, test_docs_*, the docstring contract and the tier guard give 267 passed.

@JarryShaw JarryShaw added docs Pull requests that change documentation only (docs: subject prefix) test Pull requests that add or correct tests (test: subject prefix) review: running A cross-review is in flight against the current head - no verdict yet labels Oct 26, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Review: GOOD TO GO at d319142ef (Sonnet).

  • Never shipped: git log --tags -S IPv6_GenericExt gives only b3551cb63 (add) and 93cf940b3 (rename). Both are contained in exactly the same tags (v1.5.0b7 onwards), so no release carries the name.
  • No dangling pointers: git grep GenericExt, RetiredName and two-sided all return nothing, and the removed section had no label.
  • Docstrings: the rewording ("a forbidden role") matches AenumRoleExclusionTests. The page flows from "Explicit Base Declarations" straight into "ESP's Two Facts".
  • Tests: conventions, test_docs_*, test_ipv6_ext_unit and the docstring contract give 139 passed.

@JarryShaw JarryShaw added review: good-to-go Cross-review at the current head says ready; CI state is separate review: pending No verdict for the current head - never reviewed, or the head moved since the last one and removed review: running A cross-review is in flight against the current head - no verdict yet review: good-to-go Cross-review at the current head says ready; CI state is separate labels Oct 26, 2026
Problem: docs and tests named IPv6_GenericExt, _PeekableStream,
_TCPSegment and _can_seek, none of which is in any release tag. The
no-re-export rule already forbids an old-path alias, so the mentions and
the absence guards for them add nothing.

Fix: remove the conventions page section on IPv6_GenericExt and
RetiredNameTests; drop _PeekableStream and _TCPSegment from test
docstrings and _TCPSegment from the hasattr loop; drop the _can_seek
absence assertion and rename that test to test_can_seek_is_exported.

Test: the edited test files, the conventions, docs, docstring-contract
and tier-guard tests pass.
@JarryShaw
JarryShaw force-pushed the docs/drop-unreleased-ipv6-genericext branch from d319142 to b6bd390 Compare October 26, 2026 03:28
@JarryShaw JarryShaw changed the title docs(conventions): drop the never-released IPv6_GenericExt name docs(tests): drop never-released names (IPv6_GenericExt and helpers) Oct 26, 2026
@JarryShaw JarryShaw added review: running A cross-review is in flight against the current head - no verdict yet and removed review: pending No verdict for the current head - never reviewed, or the head moved since the last one labels Oct 26, 2026
@JarryShaw

Copy link
Copy Markdown
Owner Author

Review: GOOD TO GO at b6bd390d0 (Sonnet delta review of d319142ef→b6bd390d0).

  • Never shipped: for each name, the adding and removing commits are contained in exactly the same tags. _PeekableStream and _TCPSegment first appear in v1.5.0b9, and _can_seek only in conda-1.5.0b14+1. git grep at those tags is empty, so no release tree carried any of them.
  • _TCPSegment: only that pair left the hasattr loop. Both _tcp_segment absence checks stay.
  • _can_seek: test_can_seek_is_exported keeps its __all__ check, and the docstring matches.
  • Tests: the three files plus the tier guard give 158 passed. The grep for all three names is empty.

@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 Oct 26, 2026
@JarryShaw JarryShaw added this to the PyPCAPKit v1.5 milestone Oct 26, 2026
@JarryShaw JarryShaw moved this to In review in PyPCAPKit Oct 26, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Coverage: 91.56% (unit tier, Python 3.15, b6bd390d0, Unit Tests run success)

Package Statements Missed Branches Partial Cover
pcapkit (top level) 104 4 20 2 95.16%
pcapkit/const 19599 881 2618 867 92.11%
pcapkit/corekit 2589 74 816 37 96.51%
pcapkit/dumpkit 282 3 102 3 98.44%
pcapkit/foundation 2994 23 1038 25 98.81%
pcapkit/interface 138 4 52 3 96.32%
pcapkit/protocols 17433 218 4584 185 98.15%
pcapkit/toolkit 869 36 298 10 95.20%
pcapkit/utilities 504 7 146 5 98.15%
pcapkit/vendor 4432 1988 1018 167 51.87%

Per-file detail: the coverage-html artifact of this run.

@JarryShaw

Copy link
Copy Markdown
Owner Author

Ready to merge at b6bd390d0. Owner ruling: names that shipped in no release (IPv6_GenericExt, plus the test-only _PeekableStream, _TCPSegment and _can_seek) need no mention.

  • Review: Sonnet GOOD TO GO, then a delta review of the fold-in.
  • CI: all checks complete, Required checks passed SUCCESS, 0 failed.
  • KTLO: 12 legs, no warnings.
  • Ordering: merged into main and run. project leg: 2351 tests, 0 failures.
  • Conflicts: none against the current main.

@JarryShaw
JarryShaw merged commit 35c3350 into main Oct 26, 2026
64 checks passed
@github-project-automation github-project-automation Bot moved this from In review to Done in PyPCAPKit Oct 26, 2026
@JarryShaw
JarryShaw deleted the docs/drop-unreleased-ipv6-genericext branch October 26, 2026 13:55
@JarryShaw JarryShaw removed the review: good-to-go Cross-review at the current head says ready; CI state is separate label Oct 26, 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) test Pull requests that add or correct tests (test: subject prefix)

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant