]> granicus.if.org Git - python/commitdiff
Fix docstrings for itertools combinatoric functions.
authorRaymond Hettinger <python@rcn.com>
Thu, 19 Nov 2009 01:26:23 +0000 (01:26 +0000)
committerRaymond Hettinger <python@rcn.com>
Thu, 19 Nov 2009 01:26:23 +0000 (01:26 +0000)
Doc/library/itertools.rst
Modules/itertoolsmodule.c

index bf69e21203371c0c97a4b4ec8cf0cee9919d4d26..87e99d04f071e9608b834a5630f8305cf5ccef45 100644 (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``
index a844c9335875b1f42b108aeaa6e42c2f431a3573..dc8a92acfd48eec3205ef969db734af22d53ad7d 100644 (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\
 ");