[3.14] gh-87245: Improve IPv6Address.ipv4_mapped documentation (GH-92572) (#149360)

gh-87245: Improve IPv6Address.ipv4_mapped documentation (GH-92572)

Avoid the phrasing ‘starting with ::FFFF/96’, which is confusing since
it seems to mix a prefix and a range. Instead, make it clear what the
actual range is, and refer to the relevant RFC.

Closes GH-87245.
(cherry picked from commit 7aedd0a6c6ae3b5cdd601e84411e41c56f8d00b9)

Co-authored-by: wouter bolsterlee <wouter@bolsterl.ee>

diff --git a/Doc/library/ipaddress.rst b/Doc/library/ipaddress.rst
index c546d913cbea9dc079b036c79144e9f9b2b95ef7..45256d29e854d094997fab9b2465838a82c39a6f 100644 (file)
--- a/Doc/library/ipaddress.rst
+++ b/Doc/library/ipaddress.rst
@@ -369,9 +369,9 @@ write code that handles both IP versions correctly.  Address objects are
 
    .. attribute:: ipv4_mapped
 
-      For addresses that appear to be IPv4 mapped addresses (starting with
-      ``::FFFF/96``), this property will report the embedded IPv4 address.
-      For any other address, this property will be ``None``.
+      For addresses that appear to be IPv4 mapped addresses in the range
+      ``::FFFF:0:0/96`` as defined by :RFC:`4291`, this property reports the
+      embedded IPv4 address. For any other address, this property will be ``None``.
 
    .. attribute:: scope_id