From: Raymond Hettinger <python@rcn.com>
Date: Fri, 10 Apr 2009 04:29:23 +0000 (+0000)
Subject: Clarify the table entries for combinatorics.
X-Git-Tag: v2.6.2~25
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=d06358fe3e74d80f64416cd274d58aa552aa373a;p=thirdparty%2FPython%2Fcpython.git

Clarify the table entries for combinatorics.
---

diff --git a/Doc/library/itertools.rst b/Doc/library/itertools.rst
index c0a13050e6f4..98c5216a2835 100644
--- a/Doc/library/itertools.rst
+++ b/Doc/library/itertools.rst
@@ -65,13 +65,17 @@ operator can be mapped across two vectors to form an efficient dot-product:
 
 **Combinatoric generators:**
 
-    =====================================   ====================       =================================================
-    Iterator                                Arguments                  Results
-    =====================================   ====================       =================================================
-    :func:`product`                         p, q, ... [repeat=1]       cartesian product
-    :func:`permutations`                    p[, r]                     r-length permutations (without repeated elements)
-    :func:`combinations`                    p[, r]                     r-length combinations (sorted and no repeats)
-    =====================================   ====================       =================================================
+    ==============================================   ====================       =============================================================
+    Iterator                                         Arguments                  Results
+    ==============================================   ====================       =============================================================
+    :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
+    |
+    ``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``
+    ``combinations('ABCD', 2)``                                                 ``AB AC AD BC BD CD``
+    ==============================================   ====================       =============================================================
 
 
 .. _itertools-functions: