Skip to content

Commit 3c4b194

Browse files
committed
Fix minor doc typos
1 parent 74ce41a commit 3c4b194

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

doc/source/index.rst

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ composition and iteration logic.
4040
Base
4141
----
4242

43-
A single entry `Cycler` object can be used to easily
44-
cycle over a single style. To create the `Cycler` use the :py:func:`cycler`
45-
function to link a key/style/kwarg to series of values. The key must be
46-
hashable (as it will eventually be used as the key in a :obj:`dict`).
43+
A single entry `Cycler` object can be used to easily cycle over a single style.
44+
To create the `Cycler` use the :py:func:`cycler` function to link a
45+
key/style/keyword argument to series of values. The key must be hashable (as it
46+
will eventually be used as the key in a :obj:`dict`).
4747

4848
.. ipython:: python
4949
@@ -53,7 +53,7 @@ hashable (as it will eventually be used as the key in a :obj:`dict`).
5353
color_cycle = cycler(color=['r', 'g', 'b'])
5454
color_cycle
5555
56-
The `Cycler` knows it's length and keys:
56+
The `Cycler` knows its length and keys:
5757

5858
.. ipython:: python
5959
@@ -97,7 +97,7 @@ create complex multi-key cycles.
9797
Addition
9898
~~~~~~~~
9999

100-
Equal length `Cycler` s with different keys can be added to get the
100+
Equal length `Cycler`\s with different keys can be added to get the
101101
'inner' product of two cycles
102102

103103
.. ipython:: python
@@ -180,7 +180,7 @@ matrices)
180180
Integer Multiplication
181181
~~~~~~~~~~~~~~~~~~~~~~
182182

183-
`Cycler` s can also be multiplied by integer values to increase the length.
183+
`Cycler`\s can also be multiplied by integer values to increase the length.
184184

185185
.. ipython:: python
186186
@@ -331,8 +331,7 @@ the same style.
331331
Exceptions
332332
----------
333333

334-
335-
A :obj:`ValueError` is raised if unequal length `Cycler` s are added together
334+
A :obj:`ValueError` is raised if unequal length `Cycler`\s are added together
336335

337336
.. ipython:: python
338337
:okexcept:
@@ -401,6 +400,6 @@ However, if you want to do something more complicated:
401400

402401
ax.legend(loc=0)
403402

404-
the plotting logic can quickly become very involved. To address this and allow easy
405-
cycling over arbitrary ``kwargs`` the `Cycler` class, a composable
406-
kwarg iterator, was developed.
403+
the plotting logic can quickly become very involved. To address this and allow
404+
easy cycling over arbitrary ``kwargs`` the `Cycler` class, a composable keyword
405+
argument iterator, was developed.

0 commit comments

Comments
 (0)