Fix docstrings for itertools combinatoric functions.
This commit is contained in:
parent
79628d311f
commit
9eac119ba8
|
@ -71,8 +71,8 @@ Iterator Arguments Resu
|
||||||
============================================== ==================== =============================================================
|
============================================== ==================== =============================================================
|
||||||
:func:`product` p, q, ... [repeat=1] cartesian product, equivalent to a nested for-loop
|
: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:`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
|
||||||
:func:`combinations_with_replacement` p[, r] r-length tuples, in sorted order, with repeated elements
|
:func:`combinations_with_replacement` p, r r-length tuples, in sorted order, with repeated elements
|
||||||
|
|
|
|
||||||
``product('ABCD', repeat=2)`` ``AA AB AC AD BA BB BC BD CA CB CC CD DA DB DC DD``
|
``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``
|
``permutations('ABCD', 2)`` ``AB AC AD BA BC BD CA CB CD DA DB DC``
|
||||||
|
|
|
@ -2196,7 +2196,7 @@ empty:
|
||||||
}
|
}
|
||||||
|
|
||||||
PyDoc_STRVAR(combinations_doc,
|
PyDoc_STRVAR(combinations_doc,
|
||||||
"combinations(iterable[, r]) --> combinations object\n\
|
"combinations(iterable, r) --> combinations object\n\
|
||||||
\n\
|
\n\
|
||||||
Return successive r-length combinations of elements in the iterable.\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)");
|
combinations(range(4), 3) --> (0,1,2), (0,1,3), (0,2,3), (1,2,3)");
|
||||||
|
@ -2441,7 +2441,7 @@ empty:
|
||||||
}
|
}
|
||||||
|
|
||||||
PyDoc_STRVAR(cwr_doc,
|
PyDoc_STRVAR(cwr_doc,
|
||||||
"combinations_with_replacement(iterable[, r]) --> combinations_with_replacement object\n\
|
"combinations_with_replacement(iterable, r) --> combinations_with_replacement object\n\
|
||||||
\n\
|
\n\
|
||||||
Return successive r-length combinations of elements in the iterable\n\
|
Return successive r-length combinations of elements in the iterable\n\
|
||||||
allowing individual elements to have successive repeats.\n\
|
allowing individual elements to have successive repeats.\n\
|
||||||
|
@ -4018,8 +4018,8 @@ izip_longest(p, q, ...) --> (p[0], q[0]), (p[1], q[1]), ... \n\
|
||||||
Combinatoric generators:\n\
|
Combinatoric generators:\n\
|
||||||
product(p, q, ... [repeat=1]) --> cartesian product\n\
|
product(p, q, ... [repeat=1]) --> cartesian product\n\
|
||||||
permutations(p[, r])\n\
|
permutations(p[, r])\n\
|
||||||
combinations(p[, r])\n\
|
combinations(p, r)\n\
|
||||||
combinations_with_replacement(p[, r])\n\
|
combinations_with_replacement(p, r)\n\
|
||||||
");
|
");
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue