Skip to content

Commit 40bf8d2

Browse files
author
Matthieu Lienart
committed
gh-136752: clarify ipaddress documentation of the is_reserved property
fix trailing space
1 parent f575588 commit 40bf8d2

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

Doc/library/ipaddress.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,11 @@ write code that handles both IP versions correctly. Address objects are
240240

241241
.. attribute:: is_reserved
242242

243-
``True`` if the address is otherwise IETF reserved.
243+
``True`` if the address is *labelled* as reserved by the IETF:
244+
245+
* IPv4 address ``240.0.0.0/4`` named ``Reserved``. This attribute is not related to the
246+
``Reserved-by-Protocol`` value in iana-ipv4-special-registry_
247+
* IPv6 addresses allocated as ``Reserved by IETF`` for future use (see iana-ipv6-address-space_)
244248

245249
.. attribute:: is_loopback
246250

@@ -261,6 +265,7 @@ write code that handles both IP versions correctly. Address objects are
261265

262266
.. _iana-ipv4-special-registry: https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml
263267
.. _iana-ipv6-special-registry: https://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml
268+
.. _iana-ipv6-address-space: https://www.iana.org/assignments/ipv6-address-space/ipv6-address-space.xhtml
264269

265270
.. method:: IPv4Address.__format__(fmt)
266271

0 commit comments

Comments
 (0)