https://github.com/python/cpython/commit/8f5ce42f3418dfcc37232390ba89c33b9c9ffb13
commit: 8f5ce42f3418dfcc37232390ba89c33b9c9ffb13
branch: 3.13
author: Miss Islington (bot) <[email protected]>
committer: sobolevn <[email protected]>
date: 2024-06-12T09:23:24+03:00
summary:

[3.13] gh-120128: fix description of argument to ipaddress.collapse_addresses() 
(GH-120131) (#120135)

gh-120128: fix description of argument to ipaddress.collapse_addresses() 
(GH-120131)

The argument to collapse_addresses() is now described as an *iterable*
(rather than *iterator*).
(cherry picked from commit f878d46e5614f08a9302fcb6fc611ef49e9acf2f)

Co-authored-by: Jan Kaliszewski <[email protected]>

files:
M Doc/library/ipaddress.rst
M Lib/ipaddress.py

diff --git a/Doc/library/ipaddress.rst b/Doc/library/ipaddress.rst
index d7dccf1a86593d..0441a7d47b55a5 100644
--- a/Doc/library/ipaddress.rst
+++ b/Doc/library/ipaddress.rst
@@ -990,7 +990,7 @@ The module also provides the following module level 
functions:
 .. function:: collapse_addresses(addresses)
 
    Return an iterator of the collapsed :class:`IPv4Network` or
-   :class:`IPv6Network` objects.  *addresses* is an iterator of
+   :class:`IPv6Network` objects.  *addresses* is an :term:`iterable` of
    :class:`IPv4Network` or :class:`IPv6Network` objects.  A :exc:`TypeError` is
    raised if *addresses* contains mixed version objects.
 
diff --git a/Lib/ipaddress.py b/Lib/ipaddress.py
index 8e4d49c859534d..9cef275f7ae2fc 100644
--- a/Lib/ipaddress.py
+++ b/Lib/ipaddress.py
@@ -310,7 +310,7 @@ def collapse_addresses(addresses):
                            [IPv4Network('192.0.2.0/24')]
 
     Args:
-        addresses: An iterator of IPv4Network or IPv6Network objects.
+        addresses: An iterable of IPv4Network or IPv6Network objects.
 
     Returns:
         An iterator of the collapsed IPv(4|6)Network objects.

_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]

Reply via email to