Skip to content

Commit

Permalink
gh-120128: fix description of argument to ipaddress.collapse_addresse…
Browse files Browse the repository at this point in the history
…s() (#120131)

The argument to collapse_addresses() is now described as an *iterable*
(rather than *iterator*).
  • Loading branch information
zuo authored Jun 5, 2024
1 parent e83ce85 commit f878d46
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Doc/library/ipaddress.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion Lib/ipaddress.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit f878d46

Please sign in to comment.