Fix docstrings for itertools combinatoric functions.

This commit is contained in:
Raymond Hettinger 2009-11-19 01:26:23 +00:00
parent 7cf2c80467
commit 1aef4440fb
2 changed files with 7 additions and 2 deletions

View file

@ -70,7 +70,7 @@ Iterator Arguments Resu
============================================== ==================== =============================================================
:func:`product` p, q, ... [repeat=1] cartesian product, equivalent to a nested for-loop
:func:`permutations` p[, r] r-length tuples, all possible orderings, no repeated elements
:func:`combinations` p[, r] r-length tuples, in sorted order, no repeated elements
:func:`combinations` p, r r-length tuples, in sorted order, no repeated elements
|
``product('ABCD', repeat=2)`` ``AA AB AC AD BA BB BC BD CA CB CC CD DA DB DC DD``
``permutations('ABCD', 2)`` ``AB AC AD BA BC BD CA CB CD DA DB DC``

View file

@ -2194,7 +2194,7 @@ empty:
}
PyDoc_STRVAR(combinations_doc,
"combinations(iterable[, r]) --> combinations object\n\
"combinations(iterable, r) --> combinations object\n\
\n\
Return successive r-length combinations of elements in the iterable.\n\n\
combinations(range(4), 3) --> (0,1,2), (0,1,3), (0,2,3), (1,2,3)");
@ -3542,6 +3542,11 @@ chain(p, q, ...) --> p0, p1, ... plast, q0, q1, ... \n\
takewhile(pred, seq) --> seq[0], seq[1], until pred fails\n\
dropwhile(pred, seq) --> seq[n], seq[n+1], starting when pred fails\n\
groupby(iterable[, keyfunc]) --> sub-iterators grouped by value of keyfunc(v)\n\
\n\
Combinatoric generators:\n\
product(p, q, ... [repeat=1]) --> cartesian product\n\
permutations(p[, r])\n\
combinations(p, r)\n\
");