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

index c1f8d9a932e8463fc0943d820ee851002d3042ab..30035521466263dc531ebab61a83b873cc7ece0a 100644 (file)
@@ -65,8 +65,8 @@ 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_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``
index 1df978282ceccd5135e9dc6c4fc2cd543767e9fa..3264d1f7626deddf35e668b15884a0db9168bfd1 100644 (file)
@@ -2017,7 +2017,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)");
@@ -2262,7 +2262,7 @@ empty:
 }
 
 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 @@ zip_longest(p, q, ...) --> (p[0], q[0]), (p[1], q[1]), ... \n\
 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\
 ");