Repository navigation
docs(tests): drop never-released names (IPv6_GenericExt and helpers) - #2221
Merged
Merged
Conversation
Owner
Author
|
Review: GOOD TO GO at
|
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
force-pushed
the
docs/drop-unreleased-ipv6-genericext
branch
from
October 26, 2026 03:28
d319142 to
b6bd390
Compare
Owner
Author
|
Review: GOOD TO GO at
|
Contributor
|
Coverage: 91.56% (unit tier, Python 3.15,
Per-file detail: the |
Owner
Author
|
Ready to merge 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 testpasses, and a test case covers the changeWhat is the purpose of your pull request?
docs— documentation onlyDescription
Per the owner's ruling,
IPv6_GenericExtshipped 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.IPv6_GenericExtName" fromcontributing/conventions/extension-header-subclassing.rst. Nothing linked to it.RetiredNameTestsfromtests/project/test_conventions_doc_claims.py, along with its docstring bullet and the sibling docstrings that pointed at it.IPv6_Extis still exercised bytest_ipv6_ext_unit.py.git grep GenericExtreturns nothing.test_conventions_doc_claims,test_docs_*,test_ipv6_ext_unitand the docstring contract give 139 passed._PeekableStream: dropped fromtest_io_stream_proxies_1516_unit's docstring._TCPSegment: dropped fromtest_pcap_tcp_segment_public_1570_unit's docstring and from itshasattrloop. The_tcp_segmentchecks stay._can_seek:test_can_seek_is_exported_and_the_private_name_is_gonebecomestest_can_seek_is_exported. The absence assertion is gone, and the__all__check stays.git grep -nw -e _PeekableStream -e _TCPSegment -e _can_seekreturns nothing.test_docs_*, the docstring contract and the tier guard give 267 passed.