Anonymous avatar Anonymous committed 1063481

Clarify the table entries for combinatorics.

Comments (0)

Files changed (1)

Doc/library/itertools.rst

 
 **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:
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.