8000 :books: Update `combinations` docs · python/cpython@ccb982c · GitHub
[go: up one dir, main page]

Skip to content

Commit ccb982c

Browse files
ruaridhwRuaridh Williamson
authored and
Ruaridh Williamson
committed
📚 Update combinations docs
- The order of the iterable is not modified within `combinations()` as these docs imply - Instead, the order of elements is used as-is
1 parent 6292be7 commit ccb982c

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

Doc/library/itertools.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -199,9 +199,9 @@ loops that truncate the stream.
199199

200200
Return *r* length subsequences of elements from the input *iterable*.
201201

202-
Combinations are emitted in lexicographic sort order. So, if the
203-
input *iterable* is sorted, the combination tuples will be produced
204-
in sorted order.
202+
The combination tuples are emitted in lexicographic ordering according to
203+
the order of the input *iterable*. So, if the input *iterable* is sorted,
204+
the combination tuples will be produced in sorted order.
205205

206206
Elements are treated as unique based on their position, not on their
207207
value. So if the input elements are unique, there will be no repeat
@@ -248,9 +248,9 @@ loops that truncate the stream.
248248
Return *r* length subsequences of elements from the input *iterable*
249249
allowing individual elements to be repeated more than once.
250250

251-
Combinations are emitted in lexicographic sort order. So, if the
252-
input *iterable* is sorted, the combination tuples will be produced
253-
in sorted order.
251+
The combination tuples are emitted in lexicographic ordering according to
252+
the order of the input *iterable*. So, if the input *iterable* is sorted,
253+
the combination tuples will be produced in sorted order.
254254

255255
Elements are treated as unique based on their position, not on their
256256
value. So if the input elements are unique, the generated combinations
@@ -484,9 +484,9 @@ loops that truncate the stream.
484484
of the *iterable* and all possible full-length permutations
485485
are generated.
486486

487-
Permutations are emitted in lexicographic sort order. So, if the
488-
input *iterable* is sorted, the permutation tuples will be produced
489-
in sorted order.
487+
The permutation tuples are emitted in lexicographic ordering according to
488+
the order of the input *iterable*. So, if the input *iterable* is sorted,
489+
the combination tuples will be produced in sorted order.
490490

491491
Elements are treated as unique based on their position, not on their
492492
value. So if the input elements are unique, there will be no repeat

0 commit comments

Comments
 (0)
0