[Python-checkins] r76393 - in python/branches/release31-maint: Doc/library/itertools.rst Modules/itertoolsmodule.c

[raymond.hettinger]

Author: raymond.hettinger
Date: Thu Nov 19 02:23:41 2009
New Revision: 76393

Log:
Fix docstrings for itertools combinatoric functions.

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

Modified: python/branches/release31-maint/Doc/library/itertools.rst
==============================================================================
--- python/branches/release31-maint/Doc/library/itertools.rst	(original)
+++ python/branches/release31-maint/Doc/library/itertools.rst	Thu Nov 19 02:23:41 2009
@@ -65,8 +65,8 @@
 ==============================================   ====================       =============================================================
 :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_with_replacement`            p[, r]                     r-length tuples, in sorted order, with 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
 |
 ``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/release31-maint/Modules/itertoolsmodule.c
==============================================================================
--- python/branches/release31-maint/Modules/itertoolsmodule.c	(original)
+++ python/branches/release31-maint/Modules/itertoolsmodule.c	Thu Nov 19 02:23:41 2009
@@ -2017,7 +2017,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)");
@@ -2262,7 +2262,7 @@
 }
 
 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\
 Return successive r-length combinations of elements in the iterable\n\
 allowing individual elements to have successive repeats.\n\
@@ -3494,8 +3494,8 @@
 Combinatoric generators:\n\
 product(p, q, ... [repeat=1]) --> cartesian product\n\
 permutations(p[, r])\n\
-combinations(p[, r])\n\
-combinations_with_replacement(p[, r])\n\
+combinations(p, r)\n\
+combinations_with_replacement(p, r)\n\
 ");