Fix the documented type of IPv4Address.ipv6_mapped - #157887
Merged
Merged
Conversation
It is documented as an IPv4Address object, but it returns an IPv6Address, as its own docstring says.
Documentation build overview
|
|
Thanks @Prafyl for the PR, and @StanFromIreland for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14, 3.15. |
|
GH-157918 is a backport of this pull request to the 3.15 branch. |
|
GH-157919 is a backport of this pull request to the 3.14 branch. |
|
GH-157920 is a backport of this pull request to the 3.13 branch. |
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.
The docs for
IPv4Address.ipv6_mappedinDoc/library/ipaddress.rstsay it is anbut it returns an
IPv6Address:The implementation is
return IPv6Address(f'::ffff:{self}')and the docstring already says "Return the IPv4-mapped IPv6 address", so its just the class name in the docs thats wrong. An IPv4-mapped IPv6 address cant really be anIPv4Addressanyway.Docs only, one word, no behaviour change.
ipv6_mappedwas added in 3.13 so this applies to 3.13 onwards.