ipaddress: argument to collapse_addresses() should be described as iterable
#120128
Labels
docs
Documentation in the Doc dir
Comments
zuo
changed the title
ipaddress: the argument to collapse_addresses() is described as an *iterator*, whereas any *iterable* is OKipaddress: argument to collapse_addresses() should be described as *iterable*
zuo
changed the title
ipaddress: argument to collapse_addresses() should be described as *iterable*ipaddress: argument to collapse_addresses() should be described as iterable
zuo
added a commit
to zuo/cpython
that referenced
this issue
Jun 5, 2024
…dresses() The argument to collapse_addresses() is now described as an *iterable* (rather than *iterator*).
sobolevn
pushed a commit
that referenced
this issue
Jun 5, 2024
…s() (#120131) The argument to collapse_addresses() is now described as an *iterable* (rather than *iterator*).
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this issue
Jun 5, 2024
…dresses() (pythonGH-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]>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this issue
Jun 5, 2024
…dresses() (pythonGH-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]>
sobolevn
pushed a commit
that referenced
this issue
Jun 12, 2024
…ddresses() (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 f878d46) Co-authored-by: Jan Kaliszewski <[email protected]>
hugovk
pushed a commit
that referenced
this issue
Jun 15, 2024
…ddresses() (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]>
noahbkim
pushed a commit
to hudson-trading/cpython
that referenced
this issue
Jul 11, 2024
…dresses() (python#120131) The argument to collapse_addresses() is now described as an *iterable* (rather than *iterator*).
estyxx
pushed a commit
to estyxx/cpython
that referenced
this issue
Jul 17, 2024
…dresses() (python#120131) The argument to collapse_addresses() is now described as an *iterable* (rather than *iterator*).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Documentation
In the description of the `ipaddress.collapse_addresses() function, we can read that:
Whereas, in fact, addresses can be any iterable object (not necessarily an iterator).
Therefore, I propose to change that fragment to:
...and, also, to fix the related fragment of the function's docstring – by replacing:
addresses: An iterator of IPv4Network or IPv6Network objects.withaddresses: An iterable of IPv4Network or IPv6Network objects.[Edit] PS Please note that even the already existing example in the docs (below the function's description) sets the addresses argument to an iterable (namely: a list), rather than an iterator.
Linked PRs
The text was updated successfully, but these errors were encountered: