Skip to content

Commit 4fb2af3

Browse files
miss-islingtonzuo
andauthored
[3.12] gh-120128: fix description of argument to ipaddress.collapse_addresses() (GH-120131) (#120136)
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 f878d46) Co-authored-by: Jan Kaliszewski <[email protected]>
1 parent 454f7e8 commit 4fb2af3

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

Doc/library/ipaddress.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -983,7 +983,7 @@ The module also provides the following module level functions:
983983
.. function:: collapse_addresses(addresses)
984984

985985
Return an iterator of the collapsed :class:`IPv4Network` or
986-
:class:`IPv6Network` objects. *addresses* is an iterator of
986+
:class:`IPv6Network` objects. *addresses* is an :term:`iterable` of
987987
:class:`IPv4Network` or :class:`IPv6Network` objects. A :exc:`TypeError` is
988988
raised if *addresses* contains mixed version objects.
989989

Lib/ipaddress.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ def collapse_addresses(addresses):
310310
[IPv4Network('192.0.2.0/24')]
311311
312312
Args:
313-
addresses: An iterator of IPv4Network or IPv6Network objects.
313+
addresses: An iterable of IPv4Network or IPv6Network objects.
314314
315315
Returns:
316316
An iterator of the collapsed IPv(4|6)Network objects.

0 commit comments

Comments
 (0)