[Python-checkins] r71432 - python/branches/release26-maint/Doc/library/itertools.rst

[raymond.hettinger]

Author: raymond.hettinger
Date: Fri Apr 10 06:29:23 2009
New Revision: 71432

Log:
Clarify the table entries for combinatorics.

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

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	Fri Apr 10 06:29:23 2009
@@ -65,13 +65,17 @@
 
 **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: