8000 Merge pull request #22730 from oscargus/crossreferencefixes · matplotlib/matplotlib@02e123a · GitHub
[go: up one dir, main page]
Skip to content
Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 02e123a

Browse files
timhoffmtimhoffm
authored
Merge pull request #22730 from oscargus/crossreferencefixes
Fix removed cross-references
2 parents 853312b + 7c6c5f6 commit 02e123a

15 files changed

+56
-55
lines changed

‎doc/api/prev_api_changes/api_changes_0.91.0.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Changes for 0.91.0
3131
files. In the future the class might actually parse the font to
3232
allow e.g., subsetting.
3333

34-
* :mod:`matplotlib.ft2font` now supports ``FT_Attach_File``. In
34+
* ``matplotlib.ft2font`` now supports ``FT_Attach_File``. In
3535
practice this can be used to read an afm file in addition to a
3636
pfa/pfb file, to get metrics and kerning information for a Type 1
3737
font.

‎doc/api/prev_api_changes/api_changes_0.98.x.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,13 +87,13 @@ Changes for 0.98.x
8787
:class:`~matplotlib.collections.Collection` base class.
8888

8989
* ``matplotlib.figure.Figure.figurePatch`` renamed
90-
:attr:`matplotlib.figure.Figure.patch`;
90+
``matplotlib.figure.Figure.patch``;
9191
``matplotlib.axes.Axes.axesPatch`` renamed
92-
:attr:`matplotlib.axes.Axes.patch`;
92+
``matplotlib.axes.Axes.patch``;
9393
``matplotlib.axes.Axes.axesFrame`` renamed
94-
:attr:`matplotlib.axes.Axes.frame`.
94+
``matplotlib.axes.Axes.frame``.
9595
``matplotlib.axes.Axes.get_frame``, which returns
96-
:attr:`matplotlib.axes.Axes.patch`, is deprecated.
96+
``matplotlib.axes.Axes.patch``, is deprecated.
9797

9898
* Changes in the :class:`matplotlib.contour.ContourLabeler` attributes
9999
(:func:`matplotlib.pyplot.clabel` function) so that they all have a

‎doc/api/prev_api_changes/api_changes_0.99.x.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ Changes beyond 0.99.x
2121
on or off, and applies it.
2222

2323
+ :meth:`matplotlib.axes.Axes.margins` sets margins used to
24-
autoscale the :attr:`matplotlib.axes.Axes.viewLim` based on
25-
the :attr:`matplotlib.axes.Axes.dataLim`.
24+
autoscale the ``matplotlib.axes.Axes.viewLim`` based on
25+
the ``matplotlib.axes.Axes.dataLim``.
2626

2727
+ :meth:`matplotlib.axes.Axes.locator_params` allows one to
2828
adjust axes locator parameters such as *nbins*.

‎doc/api/prev_api_changes/api_changes_1.3.x.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Code removal
3333
functionality on `matplotlib.path.Path.contains_point` and
3434
friends instead.
3535

36-
- Instead of ``axes.Axes.get_frame``, use `.axes.Axes.patch`.
36+
- Instead of ``axes.Axes.get_frame``, use ``axes.Axes.patch``.
3737

3838
- The following keyword arguments to the `~.axes.Axes.legend` function have
3939
been renamed:
@@ -102,7 +102,7 @@ Code deprecation
102102
be used. In previous Matplotlib versions this attribute was an undocumented
103103
tuple of ``(colorbar_instance, colorbar_axes)`` but is now just
104104
``colorbar_instance``. To get the colorbar axes it is possible to just use
105-
the :attr:`~matplotlib.colorbar.ColorbarBase.ax` attribute on a colorbar
105+
the ``matplotlib.colorbar.ColorbarBase.ax`` attribute on a colorbar
106106
instance.
107107

108108
* The ``matplotlib.mpl`` module is now deprecated. Those who relied on this

‎doc/api/prev_api_changes/api_changes_1.4.x.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ original location:
8282

8383
* The artist used to draw the outline of a `.Figure.colorbar` has been changed
8484
from a `matplotlib.lines.Line2D` to `matplotlib.patches.Polygon`, thus
85-
`.colorbar.ColorbarBase.outline` is now a `matplotlib.patches.Polygon`
85+
``colorbar.ColorbarBase.outline`` is now a `matplotlib.patches.Polygon`
8686
object.
8787

8888
* The legend handler interface has changed from a callable, to any object

‎doc/api/prev_api_changes/api_changes_1.5.0.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ fully delegate to `.Quiver`). Previously any input matching 'mid.*' would be
4141
interpreted as 'middle', 'tip.*' as 'tip' and any string not matching one of
4242
those patterns as 'tail'.
4343

44-
The value of `.Quiver.pivot` is normalized to be in the set {'tip', 'tail',
44+
The value of ``Quiver.pivot`` is normalized to be in the set {'tip', 'tail',
4545
'middle'} in `.Quiver`.
4646

4747
Reordered ``Axes.get_children``
@@ -116,10 +116,10 @@ In either case to update the data in the `.Line2D` object you must update
116116
both the ``x`` and ``y`` data.
117117

118118

119-
Removed *args* and *kwargs* from `.MicrosecondLocator.__call__`
120-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
119+
Removed *args* and *kwargs* from ``MicrosecondLocator.__call__``
120+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
121121

122-
The call signature of :meth:`~matplotlib.dates.MicrosecondLocator.__call__`
122+
The call signature of ``matplotlib.dates.MicrosecondLocator.__call__``
123123
has changed from ``__call__(self, *args, **kwargs)`` to ``__call__(self)``.
124124
This is consistent with the superclass :class:`~matplotlib.ticker.Locator`
125125
and also all the other Locators derived from this superclass.

‎doc/api/prev_api_changes/api_changes_2.2.0.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ rcParam.
7474
Deprecated ``Axis.unit_data``
7575
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7676

77-
Use `.Axis.units` (which has long existed) instead.
77+
Use ``Axis.units`` (which has long existed) instead.
7878

7979

8080
Removals
@@ -198,21 +198,21 @@ Changes to Qt backend class MRO
198198

199199
To support both Agg and cairo rendering for Qt backends all of the non-Agg
200200
specific code previously in ``backend_qt5agg.FigureCanvasQTAggBase`` has been
201-
moved to :class:`.backend_qt5.FigureCanvasQT` so it can be shared with the
201+
moved to ``backend_qt5.FigureCanvasQT`` so it can be shared with the
202202
cairo implementation. The ``FigureCanvasQTAggBase.paintEvent``,
203203
``FigureCanvasQTAggBase.blit``, and ``FigureCanvasQTAggBase.print_figure``
204-
methods have moved to :meth:`.FigureCanvasQTAgg.paintEvent`,
205-
:meth:`.FigureCanvasQTAgg.blit`, and :meth:`.FigureCanvasQTAgg.print_figure`.
204+
methods have moved to ``FigureCanvasQTAgg.paintEvent``,
205+
``FigureCanvasQTAgg.blit``, and ``FigureCanvasQTAgg.print_figure``.
206206
The first two methods assume that the instance is also a ``QWidget`` so to use
207207
``FigureCanvasQTAggBase`` it was required to multiple inherit from a
208208
``QWidget`` sub-class.
209209

210210
Having moved all of its methods either up or down the class hierarchy
211211
``FigureCanvasQTAggBase`` has been deprecated. To do this without warning and
212212
to preserve as much API as possible, ``.backend_qt5agg.FigureCanvasQTAggBase``
213-
now inherits from :class:`.backend_qt5.FigureCanvasQTAgg`.
213+
now inherits from ``backend_qt5.FigureCanvasQTAgg``.
214214

215-
The MRO for :class:`.FigureCanvasQTAgg` and ``FigureCanvasQTAggBase`` used to
215+
The MRO for ``FigureCanvasQTAgg`` and ``FigureCanvasQTAggBase`` used to
216216
be ::
217217

218218

‎doc/api/prev_api_changes/api_changes_3.0.0.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,7 @@ Blacklisted rcparams no longer updated by `~matplotlib.rcdefaults`, `~matplotlib
297297

298298
The rc modifier functions `~matplotlib.rcdefaults`,
299299
`~matplotlib.rc_file_defaults` and `~matplotlib.rc_file`
300-
now ignore rcParams in the `matplotlib.style.core.STYLE_BLACKLIST` set. In
300+
now ignore rcParams in the ``matplotlib.style.core.STYLE_BLACKLIST`` set. In
301301
particular, this prevents the ``backend`` and ``interactive`` rcParams from
302302
being incorrectly modified by these functions.
303303

@@ -324,12 +324,12 @@ instead of ``\usepackage{ucs}\usepackage[utf8x]{inputenc}``.
324324
Return type of ArtistInspector.get_aliases changed
325325
--------------------------------------------------
326326

327-
`ArtistInspector.get_aliases` previously returned the set of aliases as
327+
``ArtistInspector.get_aliases`` previously returned the set of aliases as
328328
``{fullname: {alias1: None, alias2: None, ...}}``. The dict-to-None mapping
329329
was used to simulate a set in earlier versions of Python. It has now been
330330
replaced by a set, i.e. ``{fullname: {alias1, alias2, ...}}``.
331331

332-
This value is also stored in `.ArtistInspector.aliasd`, which has likewise
332+
This value is also stored in ``ArtistInspector.aliasd``, which has likewise
333333
changed.
334334

335335

‎doc/api/prev_api_changes/api_changes_3.1.0.rst

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -293,9 +293,9 @@ where the `.cm.ScalarMappable` passed to `matplotlib.colorbar.Colorbar`
293293
(`~.Figure.colorbar`) had a ``set_norm`` method, as did the colorbar.
294294
The colorbar is now purely a follower to the `.ScalarMappable` norm and
295295
colormap, and the old inherited methods
296-
`~matplotlib.colorbar.ColorbarBase.set_norm`,
297-
`~matplotlib.colorbar.ColorbarBase.set_cmap`,
298-
`~matplotlib.colorbar.ColorbarBase.set_clim` are deprecated, as are
296+
``matplotlib.colorbar.ColorbarBase.set_norm``,
297+
``matplotlib.colorbar.ColorbarBase.set_cmap``,
298+
``matplotlib.colorbar.ColorbarBase.set_clim`` are deprecated, as are
299299
the getter versions of those calls. To set the norm associated with a
300300
colorbar do ``colorbar.mappable.set_norm()`` etc.
301301

@@ -394,11 +394,11 @@ returned.
394394
`matplotlib.font_manager.win32InstalledFonts` returns an empty list instead
395395
of None if no fonts are found.
396396

397-
`.Axes.fmt_xdata` and `.Axes.fmt_ydata` error handling
398-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
397+
``Axes.fmt_xdata`` and ``Axes.fmt_ydata`` error handling
398+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
399399

400-
Previously, if the user provided a `.Axes.fmt_xdata` or
401-
`.Axes.fmt_ydata` function that raised a `TypeError` (or set them to a
400+
Previously, if the user provided a ``Axes.fmt_xdata`` or
401+
``Axes.fmt_ydata`` function that raised a `TypeError` (or set them to a
402402
non-callable), the exception would be silently ignored and the default
403403
formatter be used instead. This is no longer the case; the exception
404404
is now propagated out.
@@ -476,7 +476,7 @@ Exception changes
476476
- `.Axes.streamplot` does not support irregularly gridded ``x`` and ``y`` values.
477477
So far, it used to silently plot an incorrect result. This has been changed to
478478
raise a `ValueError` instead.
479-
- The `.streamplot.Grid` class, which is internally used by streamplot
479+
- The ``streamplot.Grid`` class, which is internally used by streamplot
480480
code, also throws a `ValueError` when irregularly gridded values are
481481
passed in.
482482

@@ -566,7 +566,7 @@ in Matplotlib 2.2 has been removed. See below for a list:
566566
- ``mlab.safe_isnan`` (use `numpy.isnan` instead)
567567
- ``mlab.cohere_pairs`` (use `scipy.signal.coherence` instead)
568568
- ``mlab.entropy`` (use `scipy.stats.entropy` instead)
569-
- ``mlab.normpdf`` (use `scipy.stats.norm.pdf` instead)
569+
- ``mlab.normpdf`` (use ``scipy.stats.norm.pdf`` instead)
570570
- ``mlab.find`` (use ``np.nonzero(np.ravel(condition))`` instead)
571571
- ``mlab.longest_contiguous_ones``
572572
- ``mlab.longest_ones``
@@ -652,7 +652,7 @@ no longer available in the `pylab` module:
652652
- ``longest_ones``
653653
- ``movavg``
654654
- ``norm_flat`` (use ``numpy.linalg.norm(a.flat, ord=2)`` instead)
655-
- ``normpdf`` (use `scipy.stats.norm.pdf` instead)
655+
- ``normpdf`` (use ``scipy.stats.norm.pdf`` instead)
656656
- ``path_length``
657657
- ``poly_below``
658658
- ``poly_between``
@@ -705,7 +705,7 @@ now a no-op).
705705

706706
The image comparison test decorators now skip (rather than xfail) the test for
707707
uncomparable formats. The affected decorators are `~.image_comparison` and
708-
`~.check_figures_equal`. The deprecated `~.ImageComparisonTest` class is
708+
`~.check_figures_equal`. The deprecated ``ImageComparisonTest`` class is
709709
likewise changed.
710710

711711
Dependency changes
@@ -825,7 +825,7 @@ This has not been used in the codebase since its addition in 2009.
825825

826826
This has never been used internally, there is no equivalent method exists on
827827
the 2D Axis classes, and despite the similar name, it has a completely
828-
different behavior from the 2D Axis' `axis.Axis.get_ticks_position` method.
828+
different behavior from the 2D Axis' ``axis.Axis.get_ticks_position`` method.
829829
- ``.backend_pgf.LatexManagerFactory``
830830

831831
- ``mpl_toolkits.axisartist.axislines.SimpleChainedObjects``
@@ -936,16 +936,16 @@ Axes3D
936936
- `.axes3d.Axes3D.w_yaxis`
937937
- `.axes3d.Axes3D.w_zaxis`
938938

939-
Use `.axes3d.Axes3D.xaxis`, `.axes3d.Axes3D.yaxis` and `.axes3d.Axes3D.zaxis`
940-
instead.
939+
Use ``axes3d.Axes3D.xaxis``, ``axes3d.Axes3D.yaxis`` and
940+
``axes3d.Axes3D.zaxis`` instead.
941941

942942
Testing
943943
~~~~~~~
944944

945945
- ``matplotlib.testing.decorators.switch_backend`` decorator
946946

947947
Test functions should use ``pytest.mark.backend``, and the mark will be
948-
picked up by the `matplotlib.testing.conftest.mpl_test_settings` fixture.
948+
picked up by the ``matplotlib.testing.conftest.mpl_test_settings`` fixture.
949949

950950
Quiver
951951
~~~~~~
@@ -1069,7 +1069,7 @@ Axis
10691069

10701070
- ``Axis.iter_ticks``
10711071

1072-
This only served as a helper to the private `.Axis._update_ticks`
1072+
This only served as a helper to the private ``Axis._update_ticks``
10731073

10741074

10751075
Undeprecations
@@ -1123,10 +1123,10 @@ The `.Formatter` class gained a new `~.Formatter.format_ticks` method, which
11231123
takes the list of all tick locations as a single argument and returns the list
11241124
of all formatted values. It is called by the axis tick handling code and, by
11251125
default, first calls `~.Formatter.set_locs` with all locations, then repeatedly
1126-
calls `~.Formatter.__call__` for each location.
1126+
calls ``Formatter.__call__`` for each location.
11271127

11281128
Tick-handling code in the codebase that previously performed this sequence
1129-
(`~.Formatter.set_locs` followed by repeated `~.Formatter.__call__`) have been
1129+
(`~.Formatter.set_locs` followed by repeated ``Formatter.__call__``) have been
11301130
updated to use `~.Formatter.format_ticks`.
11311131

11321132
`~.Formatter.format_ticks` is intended to be overridden by `.Formatter`

‎doc/api/prev_api_changes/api_changes_3.2.0/behavior.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -88,13 +88,13 @@ enough to be accommodated by the default data limit margins.
8888
While the new behavior is algorithmically simpler, it is conditional on
8989
properties of the `.Collection` object:
9090

91-
1. ``offsets = None``, ``transform`` is a child of `.Axes.transData`: use the paths
91+
1. ``offsets = None``, ``transform`` is a child of ``Axes.transData``: use the paths
9292
for the automatic limits (i.e. for `.LineCollection` in `.Axes.streamplot`).
93-
2. ``offsets != None``, and ``offset_transform`` is child of `.Axes.transData`:
93+
2. ``offsets != None``, and ``offset_transform`` is child of ``Axes.transData``:
9494

95-
a) ``transform`` is child of `.Axes.transData`: use the ``path + offset`` for
95+
a) ``transform`` is child of ``Axes.transData``: use the ``path + offset`` for
9696
limits (i.e., for `.Axes.bar`).
97-
b) ``transform`` is not a child of `.Axes.transData`: just use the offsets
97+
b) ``transform`` is not a child of ``Axes.transData``: just use the offsets
9898
for the limits (i.e. for scatter)
9999

100100
3. otherwise return a null `.Bbox`.
@@ -294,7 +294,7 @@ Exception changes
294294
~~~~~~~~~~~~~~~~~
295295
Various APIs that raised a `ValueError` for incorrectly typed inputs now raise
296296
`TypeError` instead: `.backend_bases.GraphicsContextBase.set_clip_path`,
297-
`.blocking_input.BlockingInput.__call__`, `.cm.register_cmap`, `.dviread.DviFont`,
297+
``blocking_input.BlockingInput.__call__``, `.cm.register_cmap`, `.dviread.DviFont`,
298298
`.rcsetup.validate_hatch`, ``.rcsetup.validate_animation_writer_path``, `.spines.Spine`,
299299
many classes in the :mod:`matplotlib.transforms` module and :mod:`matplotlib.tri`
300300
package, and Axes methods that take a ``norm`` parameter.

‎doc/users/explain/interactive_guide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -424,7 +424,7 @@ based prompt to a ``prompt_toolkit`` based prompt. ``prompt_toolkit``
424424
has the same conceptual input hook, which is fed into ``prompt_toolkit`` via the
425425
:meth:`IPython.terminal.interactiveshell.TerminalInteractiveShell.inputhook`
426426
method. The source for the ``prompt_toolkit`` input hooks lives at
427-
:mod:`IPython.terminal.pt_inputhooks`.
427+
``IPython.terminal.pt_inputhooks``.
428428

429429

430430

‎doc/users/prev_whats_new/whats_new_3.5.0.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ Setting collection offset transform after initialization
126126
The added `.collections.Collection.set_offset_transform` may be used to set the
127127
offset transform after initialization. This can be helpful when creating a
128128
`.collections.Collection` outside an Axes object, and later adding it with
129-
`.Axes.add_collection()` and setting the offset transform to `.Axes.transData`.
129+
`.Axes.add_collection()` and setting the offset transform to ``Axes.transData``.
130130

131131
Colors and colormaps
132132
====================

‎lib/matplotlib/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -990,7 +990,7 @@ def rcdefaults():
990990
Restore the `.rcParams` from Matplotlib's internal default style.
991991
992992
Style-blacklisted `.rcParams` (defined in
993-
`matplotlib.style.core.STYLE_BLACKLIST`) are not updated.
993+
``matplotlib.style.core.STYLE_BLACKLIST``) are not updated.
994994
995995
See Also
996996
--------
@@ -1015,7 +1015,7 @@ def rc_file_defaults():
10151015
Restore the `.rcParams` from the original rc file loaded by Matplotlib.
10161016
10171017
Style-blacklisted `.rcParams` (defined in
1018-
`matplotlib.style.core.STYLE_BLACKLIST`) are not updated.
1018+
``matplotlib.style.core.STYLE_BLACKLIST``) are not updated.
10191019
"""
10201020
# Deprecation warnings were already handled when creating rcParamsOrig, no
10211021
# need to reemit them here.
@@ -1030,7 +1030,7 @@ def rc_file(fname, *, use_default_template=True):
10301030
Update `.rcParams` from file.
10311031
10321032
Style-blacklisted `.rcParams` (defined in
1033-
`matplotlib.style.core.STYLE_BLACKLIST`) are not updated.
1033+
``matplotlib.style.core.STYLE_BLACKLIST``) are not updated.
10341034
10351035
Parameters
10361036
----------

‎lib/matplotlib/axes/_axes.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1539,7 +1539,8 @@ def plot(self, *args, scalex=True, scaley=True, data=None, **kwargs):
15391539
----------------
15401540
scalex, scaley : bool, default: True
15411541
These parameters determine if the view limits are adapted to the
1542-
data limits. The values are passed on to `autoscale_view`.
1542+
data limits. The values are passed on to
1543+
`~.axes.Axes.autoscale_view`.
15431544
15441545
**kwargs : `.Line2D` properties, optional
15451546
*kwargs* are used to specify properties like a line label (for

‎lib/matplotlib/axes/_base.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2691,7 +2691,7 @@ def margins(self, *margins, x=None, y=None, tight=True):
26912691
only the y-axis.
26922692
26932693
tight : bool or None, default: True
2694-
The *tight* parameter is passed to `autoscale_view`,
2694+
The *tight* parameter is passed to `~.axes.Axes.autoscale_view`,
26952695
which is executed after a margin is changed; the default
26962696
here is *True*, on the assumption that when margins are
26972697
specified, no additional padding to match tick marks is
@@ -2777,8 +2777,8 @@ def autoscale(self, enable=True, axis='both', tight=None):
27772777
to 'z', and 'both' refers to all three axes.)
27782778
tight : bool or None, default: None
27792779
If True, first set the margins to zero. Then, this argument is
2780-
forwarded to `autoscale_view` (regardless of its value); see the
2781-
description of its behavior there.
2780+
forwarded to `~.axes.Axes.autoscale_view` (regardless of
2781+
its value); see the description of its behavior there.
27822782
"""
27832783
if enable is None:
27842784
scalex = True

0 commit comments

Comments
 (0)
0