Skip to content

General improvements to the itertools docs #98408

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
rhettinger merged 15 commits into from
Oct 18, 2022
Merged

General improvements to the itertools docs #98408

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
9a81333
Remove distracting and wordy logostic_map example.
rhettinger Oct 18, 2022
655e624
Make the groupby() code equivalent more readable
rhettinger Oct 18, 2022
b1a632a
Break islice() docs into smaller paragraphs
rhettinger Oct 18, 2022
f874f0c
Minor wording improvements for the combinatoric iterators
rhettinger Oct 18, 2022
2cd06a0
Remove redundant text covered by the example below.
rhettinger Oct 18, 2022
6e655d6
Break string of sentences into two paragraphs
rhettinger Oct 18, 2022
62f4ff6
Remove unnecessary words in tee() docs
rhettinger Oct 18, 2022
81e294a
Improve iter_index() recipe to handle non-sequence iterable inputs
rhettinger Oct 18, 2022
78d49a4
Describe the purpose of the recipes section
rhettinger Oct 18, 2022
3019dfc
Note better alternative for unique_everseen()
rhettinger Oct 18, 2022
256bb59
Missing article
rhettinger Oct 18, 2022
ac0cc45
Markup
rhettinger Oct 18, 2022
78f0586
Add imports for the new doctests
rhettinger Oct 18, 2022
1dff762
Doctest the example
rhettinger Oct 18, 2022
5138ddd
Sphinx requires an actual unicode em dash
rhettinger Oct 18, 2022
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
Break islice() docs into smaller paragraphs
  • Loading branch information
@rhettinger
rhettinger committed Oct 18, 2022
commit b1a632a36f97a7a4901831463cac2aec5d8771f8
17 changes: 11 additions & 6 deletions Doc/library/itertools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -474,10 +474,17 @@ loops that truncate the stream.
Afterward, elements are returned consecutively unless *step* is set higher than
one which results in items being skipped. If *stop* is ``None``, then iteration
continues until the iterator is exhausted, if at all; otherwise, it stops at the
specified position. Unlike regular slicing, :func:`islice` does not support
negative values for *start*, *stop*, or *step*. Can be used to extract related
fields from data where the internal structure has been flattened (for example, a
multi-line report may list a name field on every third line). Roughly equivalent to::
specified position.

If *start* is ``None``, then iteration starts at zero. If *step* is ``None``,
then the step defaults to one.

Unlike regular slicing, :func:`islice` does not support negative values for
*start*, *stop*, or *step*. Can be used to extract related fields from
data where the internal structure has been flattened (for example, a
multi-line report may list a name field on every third line).

Roughly equivalent to::

def islice(iterable, *args):
# islice('ABCDEFG', 2) --> A B
Expand All @@ -504,8 +511,6 @@ loops that truncate the stream.
for i, element in zip(range(i + 1, stop), iterable):
pass

If *start* is ``None``, then iteration starts at zero. If *step* is ``None``,
then the step defaults to one.

.. function:: pairwise(iterable)

Expand Down