Skip to content

Commit 0b797a1

Browse files
authored
Merge pull request #15061 from QuLogic/fix-xref
Fix cross-references in tutorials and FAQ
2 parents 82249b8 + fa3416a commit 0b797a1

22 files changed

+215
-470
lines changed

doc/faq/environment_variables_faq.rst

+22-10
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,21 @@ Environment Variables
88
:backlinks: none
99

1010

11-
.. envvar:: HOME
11+
.. envvar:: DISPLAY
1212

13-
The user's home directory. On linux, :envvar:`~ <HOME>` is shorthand for :envvar:`HOME`.
13+
The server and screen on which to place windows. This is interpreted by GUI
14+
toolkits in a backend-specific manner, but generally refers to an `X.org
15+
display name
16+
<https://www.x.org/releases/X11R7.7/doc/man/man7/X.7.xhtml#heading5>`_.
1417

15-
.. envvar:: PATH
18+
.. envvar:: HOME
1619

17-
The list of directories searched to find executable programs
20+
The user's home directory. On linux, :envvar:`~ <HOME>` is shorthand for :envvar:`HOME`.
1821

19-
.. envvar:: PYTHONPATH
22+
.. envvar:: MPLBACKEND
2023

21-
The list of directories that is added to Python's standard search list when
22-
importing packages and modules
24+
This optional variable can be set to choose the Matplotlib backend. See
25+
:ref:`what-is-a-backend`.
2326

2427
.. envvar:: MPLCONFIGDIR
2528

@@ -31,10 +34,19 @@ Environment Variables
3134
is used to find a base directory in which the :file:`matplotlib` subdirectory
3235
is created.
3336

34-
.. envvar:: MPLBACKEND
37+
.. envvar:: PATH
3538

36-
This optional variable can be set to choose the matplotlib backend. See
37-
:ref:`what-is-a-backend`.
39+
The list of directories searched to find executable programs.
40+
41+
.. envvar:: PYTHONPATH
42+
43+
The list of directories that are added to Python's standard search list when
44+
importing packages and modules.
45+
46+
.. envvar:: QT_API
47+
48+
The Python Qt wrapper to prefer when using Qt-based backends. See :ref:`the
49+
entry in the usage guide <QT_API-usage>` for more information.
3850

3951
.. _setting-linux-osx-environment-variables:
4052

doc/faq/howto_faq.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ converter with the `matplotlib.units` module::
2727
from pandas.tseries import converter as pdtc
2828
pdtc.register()
2929

30-
If you only want to use the `pandas` converter for `datetime64` values ::
30+
If you only want to use the `pandas` converter for `numpy.datetime64` values ::
3131

3232
from pandas.tseries import converter as pdtc
3333
import matplotlib.units as munits
@@ -48,7 +48,7 @@ recursively search the artist for any artists it may contain that meet
4848
some criteria (e.g., match all :class:`~matplotlib.lines.Line2D`
4949
instances or match some arbitrary filter function). For example, the
5050
following snippet finds every object in the figure which has a
51-
`set_color` property and makes the object blue::
51+
``set_color`` property and makes the object blue::
5252

5353
def myfunc(x):
5454
return hasattr(x, 'set_color')
@@ -246,8 +246,8 @@ over so that the tick labels fit in the figure:
246246
Configure the tick widths
247247
-------------------------
248248

249-
Wherever possible, it is recommended to use the :meth:`~Axes.tick_params` or
250-
:meth:`~Axis.set_tick_params` methods to modify tick properties::
249+
Wherever possible, it is recommended to use the :meth:`~.axes.Axes.tick_params`
250+
or :meth:`~.axis.Axis.set_tick_params` methods to modify tick properties::
251251

252252
import matplotlib.pyplot as plt
253253

@@ -648,7 +648,7 @@ In general, the simplest solution when using Matplotlib in a web server is
648648
to completely avoid using pyplot (pyplot maintains references to the opened
649649
figures to make `~.matplotlib.pyplot.show` work, but this will cause memory
650650
leaks unless the figures are properly closed). Since Matplotlib 3.1, one
651-
can directly create figures using the `Figure` constructor and save them to
651+
can directly create figures using the `.Figure` constructor and save them to
652652
in-memory buffers. The following example uses Flask_, but other frameworks
653653
work similarly::
654654

0 commit comments

Comments
 (0)