[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 f878d46e56)

Co-authored-by: Jan Kaliszewski <zuo@kaliszewski.net>
This commit is contained in:
Miss Islington (bot) 2024-06-12 08:23:24 +02:00 committed by GitHub
parent 7aafa305d4
commit 8f5ce42f34
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 2 additions and 2 deletions

View file

@ -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.

View file

@ -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.