# [Python-checkins] r76394 - in python/branches/release26-maint: Doc/library/itertools.rst Modules/itertoolsmodule.c

raymond.hettinger python-checkins at python.org
Thu Nov 19 02:26:24 CET 2009

Author: raymond.hettinger
Date: Thu Nov 19 02:26:23 2009
New Revision: 76394

Log:
Fix docstrings for itertools combinatoric functions.

Modified:
python/branches/release26-maint/Doc/library/itertools.rst
python/branches/release26-maint/Modules/itertoolsmodule.c

Modified: python/branches/release26-maint/Doc/library/itertools.rst
==============================================================================
--- python/branches/release26-maint/Doc/library/itertools.rst	(original)
+++ python/branches/release26-maint/Doc/library/itertools.rst	Thu Nov 19 02:26:23 2009
@@ -70,7 +70,7 @@
==============================================   ====================       =============================================================
: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``

Modified: python/branches/release26-maint/Modules/itertoolsmodule.c
==============================================================================
--- python/branches/release26-maint/Modules/itertoolsmodule.c	(original)
+++ python/branches/release26-maint/Modules/itertoolsmodule.c	Thu Nov 19 02:26:23 2009
@@ -2194,7 +2194,7 @@
}

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 @@
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\
");