8000 Some manual fixes. · matplotlib/matplotlib@844b28c · GitHub
[go: up one dir, main page]
Skip to content

Commit 844b28c

Browse files
anntzeranntzer
committed
Some manual fixes.
1 parent bded7cb commit 844b28c

File tree

16 files changed

+54
-63
lines changed

16 files changed

+54
-63
lines changed

‎examples/color/color_cycle_default.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
====================================
55
66
Display the colors from the default prop_cycle, which is obtained from the
7-
:ref:`rc parameters</tutorials/introductory/customizing>`.
7+
:doc:`rc parameters</tutorials/introductory/customizing>`.
88
"""
99
import numpy as np
1010
import matplotlib.pyplot as plt

‎examples/color/color_cycler.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,10 @@
88
99
This example demonstrates two different APIs:
1010
11-
1. Setting the default
12-
:doc:`rc parameter</tutorials/introductory/customizing>`
13-
specifying the property cycle. This affects all subsequent axes
14-
(but not axes already created).
15-
2. Setting the property cycle for a single pair of axes.
11+
1. Setting the default :doc:`rc parameter</tutorials/introductory/customizing>`
12+
specifying the property cycle. This affects all subsequent axes (but not
13+
axes already created).
14+
2. Setting the property cycle for a single pair of axes.
1615
"""
1716
from cycler import cycler
1817
import numpy as np

‎examples/images_contours_and_fields/contour_demo.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@
66
Illustrate simple contour plotting, contours on an image with
77
a colorbar for the contours, and labelled contours.
88
9-
See also the
10-
:ref:`contour image example
9+
See also the :doc:`contour image example
1110
</gallery/images_contours_and_fields/contour_image>`.
1211
"""
1312
import matplotlib

‎examples/images_contours_and_fields/contour_image.py

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,14 @@
44
=============
55
66
Test combinations of contouring, filled contouring, and image plotting.
7-
For contour labelling, see See also the
8-
:ref:`contour demo example
7+
For contour labelling, see also the :doc:`contour demo example
98
</gallery/images_contours_and_fields/contour_demo>`.
109
1110
The emphasis in this demo is on showing how to make contours register
12-
correctly on images, and on how to get both of them oriented as
13-
desired. In particular, note the usage of the
14-
:ref:`"origin" and "extent"
15-
</tutorials/intermediate/imshow_extent>`
16-
keyword arguments to imshow and contour.
11+
correctly on images, and on how to get both of them oriented as desired.
12+
In particular, note the usage of the :doc:`"origin" and "extent"
13+
</tutorials/intermediate/imshow_extent>` keyword arguments to imshow and
14+
contour.
1715
"""
1816
import matplotlib.pyplot as plt
1917
import numpy as np

‎examples/images_contours_and_fields/contour_label_demo.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
Illustrate some of the more advanced things that one can do with
77
contour labels.
88
9-
See also the :ref:`contour demo example
9+
See also the :doc:`contour demo example
1010
</gallery/images_contours_and_fields/contour_demo>`.
1111
"""
1212

‎examples/images_contours_and_fields/image_demo.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@
137137
# x[0,0] in the upper left or lower right by using the origin parameter.
138138
# You can also control the default setting image.origin in your
139139
# :ref:`matplotlibrc file <customizing-with-matplotlibrc-files>`. For more on
140-
# this topic see the :ref:`complete guide on origin and extent
140+
# this topic see the :doc:`complete guide on origin and extent
141141
# </tutorials/intermediate/imshow_extent>`.
142142

143143
x = np.arange(120).reshape((10, 12))

‎examples/images_contours_and_fields/quiver_demo.py

F438
Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,13 @@
33
Demonstration of advanced quiver and quiverkey functions
44
========================================================
55
6-
Demonstrates some more advanced options for `~.axes.Axes.quiver`.
7-
For a simple example refer to
8-
:doc:`/gallery/images_contours_and_fields/quiver_simple_demo`.
6+
Demonstrates some more advanced options for `~.axes.Axes.quiver`. For a simple
7+
example refer to :doc:`/gallery/images_contours_and_fields/quiver_simple_demo`.
98
10-
Known problem: the plot autoscaling does not take into account
11-
the arrows, so those on the boundaries are often out of the picture.
12-
This is *not* an easy problem to solve in a perfectly general way.
13-
The workaround is to manually expand the Axes objects.
9+
Known problem: the plot autoscaling does not take into account the arrows, so
10+
those on the boundaries are often out of the picture. This is *not* an easy
11+
problem to solve in a perfectly general way. The workaround is to manually
12+
expand the Axes objects.
1413
"""
1514
import matplotlib.pyplot as plt
1615
import numpy as np

‎examples/images_contours_and_fields/quiver_simple_demo.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,9 @@
33
Quiver Simple Demo
44
==================
55
6-
A simple example of a `~.axes.Axes.quiver` plot with a
7-
`~.axes.Axes.quiverkey`.
6+
A simple example of a `~.axes.Axes.quiver` plot with a `~.axes.Axes.quiverkey`.
87
9-
For more advanced options refer to
8+
For more advanced options refer to
109
:doc:`/gallery/images_contours_and_fields/quiver_demo`.
1110
"""
1211
import matplotlib.pyplot as plt

‎examples/shapes_and_collections/ellipse_demo.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
============
55
66
Draw many ellipses. Here individual ellipses are drawn. Compare this
7-
to the :ref:`Ellipse collection example
7+
to the :doc:`Ellipse collection example
88
</gallery/shapes_and_collections/ellipse_collection>`.
99
"""
1010
import matplotlib.pyplot as plt

‎lib/matplotlib/legend.py

Lines changed: 14 additions & 16 deletions
F42D
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,21 @@
44
55
.. important::
66
7-
It is unlikely that you would ever create a Legend instance manually.
8-
Most users would normally create a legend via the
7+
It is unlikely that you would ever create a Legend instance
8+
manually. Most users would normally create a legend via the
99
:meth:`~matplotlib.axes.Axes.legend` function. For more details on legends
10-
there is also a :ref:`legend guide
11-
</tutorials/intermediate/legend_guide>`.
12-
13-
The Legend class can be considered as a container of legend handles
14-
and legend texts. Creation of corresponding legend handles from the
15-
plot elements in the axes or figures (e.g., lines, patches, etc.) are
16-
specified by the handler map, which defines the mapping between the
17-
plot elements and the legend handlers to be used (the default legend
18-
handlers are defined in the :mod:`~matplotlib.legend_handler` module).
19-
Note that not all kinds of artist are supported by the legend yet by default
20-
but it is possible to extend the legend handler's capabilities to support
21-
arbitrary objects. See the :ref:`legend guide
22-
</tutorials/intermediate/legend_guide>` for more information.
23-
10+
there is also a :doc:`legend guide </tutorials/intermediate/legend_guide>`.
11+
12+
The Legend class can be considered as a container of legend handles and
13+
legend texts. Creation of corresponding legend handles from the plot elements
14+
in the axes or figures (e.g., lines, patches, etc.) are specified by the
15+
handler map, which defines the mapping between the plot elements and the
16+
legend handlers to be used (the default legend handlers are defined in the
17+
:mod:`~matplotlib.legend_handler` module). Note that not all kinds of
18+
artist are supported by the legend yet by default but it is possible to
19+
extend the legend handler's capabilities to support arbitrary objects. See
20+
the :doc:`legend guide </tutorials/intermediate/legend_guide>` for more
21+
information.
2422
"""
2523

2624
import logging

‎lib/matplotlib/legend_handler.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""
22
This module defines default legend handlers.
33
4-
It is strongly encouraged to have read the :ref:`legend guide
4+
It is strongly encouraged to have read the :doc:`legend guide
55
</tutorials/intermediate/legend_guide>` before this documentation.
66
77
Legend handlers are expected to be a callable object with a following

‎lib/matplotlib/widgets.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2574,7 +2574,7 @@ class PolygonSelector(_SelectorWidget):
25742574
if the mouse click is within `vertex_select_radius` pixels of the
25752575
vertex. The default radius is 15 pixels.
25762576
2577-
See Also
2577+
Examples
25782578
--------
25792579
:doc:`/gallery/widgets/polygon_selector_demo`
25802580
"""

‎tutorials/introductory/lifecycle.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,10 @@
2323
interface. In this case, we utilize an instance of :class:`axes.Axes`
2424
in order to render visualizations on an instance of :class:`figure.Figure`.
2525
26-
The second is based on MATLAB and uses
27-
a state-based interface. This is encapsulated in the :mod:`pyplot`
28-
module. See the :ref:`pyplot tutorials
29-
</tutorials/introductory/pyplot>`
30-
for a more in-depth look at the pyplot interface.
26+
The second is based on MATLAB and uses a state-based interface. This is
27+
encapsulated in the :mod:`pyplot` module. See the :doc:`pyplot tutorials
28+
</tutorials/introductory/pyplot>` for a more in-depth look at the pyplot
29+
interface.
3130
3231
Most of the terms are straightforward but the main thing to remember
3332
is that:
@@ -85,7 +84,7 @@
8584
# .. note::
8685
#
8786
# Figures can have multiple axes on them. For information on how to do this,
88-
# see the :ref:`Tight Layout tutorial
87+
# see the :doc:`Tight Layout tutorial
8988
# </tutorials/intermediate/tight_layout_guide>`.
9089

9190
fig, ax = plt.subplots()

‎tutorials/text/mathtext.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
#
6464
# have special meaning outside of math mode in TeX. Therefore, these
6565
# characters will behave differently depending on the rcParam
66-
# ``text.usetex`` flag. See the :ref:`usetex tutorial
66+
# ``text.usetex`` flag. See the :doc:`usetex tutorial
6767
# </tutorials/text/usetex>` for more information.
6868
#
6969
# Subscripts and superscripts

‎tutorials/text/text_props.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@
217217
# font.sans-serif: Source Han Sans TW, Arial, sans-serif
218218
#
219219
# To control the font used on per-artist basis use the ``'name'``,
220-
# ``'fontname'`` or ``'fontproperties'`` kwargs documented :ref:`above
220+
# ``'fontname'`` or ``'fontproperties'`` kwargs documented :doc:`above
221221
# </tutorials/text/text_props>`.
222222
#
223223
#

‎tutorials/text/usetex.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,21 @@
1212
* PS
1313
* PDF
1414
15-
The LaTeX option is activated by setting ``text.usetex : True`` in
16-
your rc settings. Text handling with matplotlib's LaTeX support is
17-
slower than matplotlib's very capable :ref:`mathtext
18-
</tutorials/text/mathtext>`, but is more flexible, since different LaTeX
19-
packages (font packages, math packages, etc.) can be used. The
20-
results can be striking, especially when you take care to use the same
21-
fonts in your figures as in the main document.
15+
The LaTeX option is activated by setting ``text.usetex : True`` in your rc
16+
settings. Text handling with matplotlib's LaTeX support is slower than
17+
matplotlib's very capable :doc:`mathtext </tutorials/text/mathtext>`, but is
18+
more flexible, since different LaTeX packages (font packages, math packages,
19+
etc.) can be used. The results can be striking, especially when you take care
20+
to use the same fonts in your figures as in the main document.
2221
2322
Matplotlib's LaTeX support requires a working LaTeX_ installation, dvipng_
2423
(which may be included with your LaTeX installation), and Ghostscript_
2524
(GPL Ghostscript 8.60 or later is recommended). The executables for these
2625
external dependencies must all be located on your :envvar:`PATH`.
2726
28-
There are a couple of options to mention, which can be changed using :ref:`rc
29-
settings </tutorials/introductory/customizing>`. Here is an example matplotlibrc file::
27+
There are a couple of options to mention, which can be changed using
28+
:doc:`rc settings </tutorials/introductory/customizing>`. Here is an example
29+
matplotlibrc file::
3030
3131
font.family : serif
3232
font.serif : Times, Palatino, New Century Schoolbook, Bookman, Computer Modern Roman

0 commit comments

Comments
 (0)
0