DOC/WIP

tacaswell · tacaswell · commit 3b905c113a1a · 2015-05-06T21:18:17.000-04:00
diff --git a/doc/users/cycler.rst b/doc/users/cycler.rst
@@ -81,53 +81,64 @@ kwarg iterator, was developed.
 `Cycler` Usage
 ==============
 
-A 'base' `Cycler` object is some what useful and can be used to easily
+A 'base' `Cycler` object is somewhat useful and can be used to easily
 cycle over a single style
 
-.. plot::
-   :include-source:
+.. ipython:: python
 
+   from __future__ import print_function
    from matplotlib.cycler import cycler
-   from itertools import cycle
 
-   fig, (ax1, ax2) = plt.subplots(1, 2, tight_layout=True, figsize=(8, 4))
-   x = np.arange(10)
 
-   color_cycle = cycler('c', ['r', 'g', 'b'])
+   color_cycle = cycler('c', ['r', 'g', 'b', 'purple'])
 
-   for i, sty in enumerate(color_cycle):
-      ax1.plot(x, x*(i+1), **sty)
+   color_cycle
 
+   for v in color_cycle:
+       print(v)
 
-   for i, sty in zip(range(1, 10), cycle(color_cycle)):
-      ax2.plot(x, x*i, **sty)
+   len(color_cycle)
+   color_cycle.keys
 
+Cycles can be sliced with `silce` objects
 
 .. ipython:: python
 
-   from __future__ import print_function
-   from matplotlib.cycler import cycler
+   color_cycle[::-1]
+   color_cycle[:2]
+   color_cycle[1:]
 
+to return a sub-set of the cycle as a new `Cycler`.  They can also be multiplied
+by scalars to make fixed length periodic cycles
 
-   color_cycle = cycler('c', ['r', 'g', 'b'])
+.. ipython:: python
 
-   color_cycle
+   color_cycle * 2
+   2 * color_cycle[:2]
 
-   for v in color_cycle:
-       print(v)
+but the real power of `Cycler` objects is when composing them. Equal
+length `Cycler` with different keys can be added to get the 'inner'
+product of two cycles
 
-   len(color_cycle)
+.. ipython:: python
 
+   lw_cycle = cycler('lw', range(1, 5))
+   ls_cycle = cycler('ls', ['-', '--'])
 
-   fig, (ax1, ax2) = plt.subplots(1, 2, tight_layout=True, figsize=(8, 4))
-   x = np.arange(10)
+   wc = lw_cycle + color_cycle
+   wc
+   len(wc)
+   wc.keys
 
+   color_cycle + ls_cycle*2
 
-   for i, sty in enumerate(color_cycle):
-      ax1.plot(x, x*(i+1), **sty)
+   color_color + ls_cycle
 
+and any pair of `Cycler` can be multiplied
 
+.. ipython:: python
 
+   ls_cycle * color_cycle
 
 
 However they are most useful when composed.  They can be added
@@ -166,6 +177,25 @@ complicated cycles to be defined very succinctly
 .. ipython:: python
 
 
+.. plot::
+   :include-source:
+
+   from matplotlib.cycler import cycler
+   from itertools import cycle
+
+   fig, (ax1, ax2) = plt.subplots(1, 2, tight_layout=True, figsize=(8, 4))
+   x = np.arange(10)
+
+   color_cycle = cycler('c', ['r', 'g', 'b'])
+
+   for i, sty in enumerate(color_cycle):
+      ax1.plot(x, x*(i+1), **sty)
+
+
+   for i, sty in zip(range(1, 10), cycle(color_cycle)):
+      ax2.plot(x, x*i, **sty)
+
+
 .. plot::
    :include-source:
 
