Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Misc cleanups and wording improvements for the itertools docs #119626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
May 27, 2024
Merged

Misc cleanups and wording improvements for the itertools docs #119626

Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
e42bf24
Tighten the wording for permutations(). Add links.
rhettinger May 25, 2024
2c2bb68
Tighten the wording for combinations(). Add links.
rhettinger May 25, 2024
269b506
Tighten the wording for combinations_with_replacement().
rhettinger May 25, 2024
642e89f
Tighen wording for islice()
rhettinger May 25, 2024
c581a38
Swap sentence order
rhettinger May 26, 2024
598c414
.
rhettinger May 26, 2024
a558705
Sync table examples with main docs
rhettinger May 27, 2024
2974acd
Improve readability of the amortization example
rhettinger May 27, 2024
295baa4
Improve accumulate() docs
rhettinger May 27, 2024
d3e6800
.
rhettinger May 27, 2024
1f52c89
Improve wording for compress()
rhettinger May 27, 2024
95f503b
Improve wording for count()
rhettinger May 27, 2024
61f629d
Tighter wording for cycle()
rhettinger May 27, 2024
95e82ed
Improve wording for dropwhile()
rhettinger May 27, 2024
6cfce87
Misc wording tweaks
rhettinger May 27, 2024
d60c375
Tweak starmap() wording
rhettinger May 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Misc wording tweaks
  • Loading branch information
@rhettinger
rhettinger committed May 27, 2024
commit 6cfce87bcc5321c4059ed9458367e588f708ccb2
37 changes: 23 additions & 14 deletions Doc/library/itertools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,9 +389,10 @@ loops that truncate the stream.

.. function:: filterfalse(predicate, iterable)

Make an iterator that filters elements from iterable returning only those for
which the predicate is false. If *predicate* is ``None``, return the items
that are false. Roughly equivalent to::
Make an iterator that filters elements from iterable returning only
those for which the *predicate* returns a false value. If
*predicate* is ``None``, return the items that are false. Roughly
equivalent to::

def filterfalse(predicate, iterable):
# filterfalse(lambda x: x<5, [1,4,6,3,8]) → 6 8
Expand Down Expand Up @@ -599,10 +600,13 @@ loops that truncate the stream.
def product(*iterables, repeat=1):
# product('ABCD', 'xy') → Ax Ay Bx By Cx Cy Dx Dy
# product(range(2), repeat=3) → 000 001 010 011 100 101 110 111

pools = [tuple(pool) for pool in iterables] * repeat

result = [[]]
for pool in pools:
result = [x+[y] for x in result for y in pool]

for prod in result:
yield tuple(prod)

Expand Down Expand Up @@ -638,10 +642,10 @@ loops that truncate the stream.

.. function:: starmap(function, iterable)

Make an iterator that computes the function using arguments obtained from
the iterable. Used instead of :func:`map` when argument parameters are already
grouped in tuples from a single iterable (when the data has been
"pre-zipped").
Make an iterator that computes the function using arguments obtained
from the *iterable*. Used instead of :func:`map` when argument
parameters are already grouped in tuples from a single iterable (when
the data has been "pre-zipped").

The difference between :func:`map` and :func:`starmap` parallels the
distinction between ``function(a,b)`` and ``function(*c)``. Roughly
Expand All @@ -655,8 +659,8 @@ loops that truncate the stream.

.. function:: takewhile(predicate, iterable)

Make an iterator that returns elements from the iterable as long as the
predicate is true. Roughly equivalent to::
Make an iterator that returns elements from the *iterable* as long as
the *predicate* is true. Roughly equivalent to::

def takewhile(predicate, iterable):
# takewhile(lambda x: x<5, [1,4,6,3,8]) → 1 4
Expand Down Expand Up @@ -712,9 +716,15 @@ loops that truncate the stream.

.. function:: zip_longest(*iterables, fillvalue=None)

Make an iterator that aggregates elements from each of the iterables. If the
iterables are of uneven length, missing values are filled-in with *fillvalue*.
Iteration continues until the longest iterable is exhausted. Roughly equivalent to::
Make an iterator that aggregates elements from each of the
*iterables*.

If the iterables are of uneven length, missing values are filled-in
with *fillvalue*. If not specified, *fillvalue* defaults to ``None``.

Iteration continues until the longest iterable is exhausted.

Roughly equivalent to::

def zip_longest(*iterables, fillvalue=None):
# zip_longest('ABCD', 'xy', fillvalue='-') → Ax By C- D-
Expand All @@ -740,8 +750,7 @@ loops that truncate the stream.

If one of the iterables is potentially infinite, then the :func:`zip_longest`
function should be wrapped with something that limits the number of calls
(for example :func:`islice` or :func:`takewhile`). If not specified,
*fillvalue* defaults to ``None``.
(for example :func:`islice` or :func:`takewhile`).


.. _itertools-recipes:
Expand Down