@@ -722,9 +722,11 @@ def cycler(*args, **kwargs):
722
722
Creates a :class:`cycler.Cycler` object much like :func:`cycler.cycler`,
723
723
but includes input validation.
724
724
725
- cycler(arg)
726
- cycler(label, itr)
727
- cycler(label1=itr1[, label2=itr2[, ...]])
725
+ Call signatures::
726
+
727
+ cycler(cycler)
728
+ cycler(label, values)
729
+ cycler(label=values[, label2=values2[, ...]])
728
730
729
731
Form 1 simply copies a given `Cycler` object.
730
732
@@ -736,15 +738,15 @@ def cycler(*args, **kwargs):
736
738
737
739
Parameters
738
740
----------
739
- arg : Cycler
741
+ cycler : Cycler
740
742
Copy constructor for Cycler.
741
743
742
- label : name
743
- The property key. Must be a valid `Artist` property.
744
+ label : str
745
+ The property key. Must be a valid `. Artist` property.
744
746
For example, 'color' or 'linestyle'. Aliases are allowed,
745
747
such as 'c' for 'color' and 'lw' for 'linewidth'.
746
748
747
- itr : iterable
749
+ values : iterable
748
750
Finite-length iterable of the property values. These values
749
751
are validated and will raise a ValueError if invalid.
750
752
@@ -753,6 +755,19 @@ def cycler(*args, **kwargs):
753
755
cycler : Cycler
754
756
New :class:`cycler.Cycler` for the given properties
755
757
758
+ Examples
759
+ --------
760
+ Creating a cycler for a single property:
761
+
762
+ >>> c = cycler(color=['red', 'green', 'blue']) # or
763
+ >>> c = cycler('color', ['red', 'green', 'blue'])
764
+
765
+ Creating a cycler for simultaneously cycling over multiple properties
766
+ (e.g. red circle, green plus, blue cross):
767
+
768
+ >>> c = cycler(color=['red', 'green', 'blue'],
769
+ ... marker=['o', '+', 'x'])
770
+
756
771
"""
757
772
if args and kwargs :
758
773
raise TypeError ("cycler() can only accept positional OR keyword "
0 commit comments