Skip to content

Commit f653879

Browse files
authored
Fix more missing references. (matplotlib#16115)
Fix more missing references.
2 parents 45cfd87 + d4494ea commit f653879

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+269
-930
lines changed

doc/api/prev_api_changes/api_changes_3.0.0.rst

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ This new default may be overridden in either of three ways:
6565
------------------------------------------------------------------
6666

6767
`Text.set_text` when passed a string value of ``None`` would set the
68-
string to ``"None"``, so subsequent calls to `Text.get_text` would return
68+
string to ``"None"``, so subsequent calls to `.Text.get_text` would return
6969
the ambiguous ``"None"`` string.
7070

7171
This change sets text objects passed ``None`` to have empty strings, so that
@@ -106,7 +106,7 @@ Different exception types for undocumented options
106106
- Passing the undocumented ``xmin`` or ``xmax`` arguments to
107107
:meth:`~matplotlib.axes.Axes.set_xlim` would silently override the ``left``
108108
and ``right`` arguments. :meth:`~matplotlib.axes.Axes.set_ylim` and the
109-
3D equivalents (e.g. :meth:`~mpl_toolkits.axes.Axes3D.set_zlim3d`) had a
109+
3D equivalents (e.g. `~.Axes3D.set_zlim3d`) had a
110110
corresponding problem.
111111
A ``TypeError`` will be raised if they would override the earlier
112112
limit arguments. In 3.0 these were kwargs were deprecated, but in 3.1
@@ -116,14 +116,14 @@ Different exception types for undocumented options
116116
Improved call signature for ``Axes.margins``
117117
--------------------------------------------
118118

119-
:meth:`matplotlib.axes.Axes.margins` and :meth:`mpl_toolkits.mplot3d.Axes3D.margins`
119+
`.Axes.margins` and `.Axes3D.margins`
120120
no longer accept arbitrary keywords. ``TypeError`` will therefore be raised
121121
if unknown kwargs are passed; previously they would be silently ignored.
122122

123123
If too many positional arguments are passed, ``TypeError`` will be raised
124124
instead of ``ValueError``, for consistency with other call-signature violations.
125125

126-
``Axes3D.margins`` now raises ``TypeError`` instead of emitting a deprecation
126+
`.Axes3D.margins` now raises ``TypeError`` instead of emitting a deprecation
127127
warning if only two positional arguments are passed. To supply only ``x`` and
128128
``y`` margins, use keyword arguments.
129129

@@ -140,7 +140,7 @@ now raise ``TypeError`` because ``**kwargs`` has been removed.
140140

141141
- :meth:`matplotlib.axes.Axes.stem` no longer accepts unknown keywords,
142142
and raises ``TypeError`` instead of emitting a deprecation.
143-
- :meth:`matplotlib.axex.Axes.stem` now raises TypeError when passed
143+
- :meth:`matplotlib.axes.Axes.stem` now raises TypeError when passed
144144
unhandled positional arguments. If two or more arguments are passed
145145
(ie X, Y, [linefmt], ...) and Y cannot be cast to an array, an error
146146
will be raised instead of treating X as Y and Y as linefmt.
@@ -161,18 +161,18 @@ Non-interactive FigureManager classes are now aliases of FigureManagerBase
161161
--------------------------------------------------------------------------
162162

163163
The `FigureManagerPdf`, `FigureManagerPS`, and `FigureManagerSVG` classes,
164-
which were previously empty subclasses of `FigureManagerBase` (i.e., not
164+
which were previously empty subclasses of `.FigureManagerBase` (i.e., not
165165
adding or overriding any attribute or method), are now direct aliases for
166-
`FigureManagerBase`.
166+
`.FigureManagerBase`.
167167

168168

169169
Change to the output of `.image.thumbnail`
170170
------------------------------------------
171171

172172
When called with ``preview=False``, `.image.thumbnail` previously returned an
173173
figure whose canvas class was set according to the output file extension. It
174-
now returns a figure whose canvas class is the base `FigureCanvasBase` (and
175-
relies on `FigureCanvasBase.print_figure`) to handle the canvas switching
174+
now returns a figure whose canvas class is the base `.FigureCanvasBase` (and
175+
relies on `.FigureCanvasBase.print_figure`) to handle the canvas switching
176176
properly).
177177

178178
As a side effect of this change, `.image.thumbnail` now also supports .ps, .eps,
@@ -204,7 +204,7 @@ When contour is called with levels specified as a target number rather
204204
than a list, and the 'extend' kwarg is used, the levels are now chosen
205205
such that some data typically will fall in the extended range.
206206

207-
When contour is called with a `LogNorm` or a `LogLocator`, it will now
207+
When contour is called with a `.LogNorm` or a `.LogLocator`, it will now
208208
select colors using the geometric mean rather than the arithmetic mean
209209
of the contour levels.
210210

@@ -216,8 +216,8 @@ A bug was fixed where the last row and column of data in
216216
`~.Axes.axes.streamplot` were being dropped.
217217

218218

219-
Changed default `AutoDateLocator` kwarg *interval_multiples* to ``True``
220-
------------------------------------------------------------------------
219+
Changed default `.AutoDateLocator` kwarg *interval_multiples* to ``True``
220+
-------------------------------------------------------------------------
221221

222222
The default value of the tick locator for dates, `.dates.AutoDateLocator`
223223
kwarg *interval_multiples* was set to ``False`` which leads to not-nice
@@ -278,7 +278,7 @@ original behavior.
278278
Colorbar for log-scaled hexbin
279279
------------------------------
280280

281-
When using `hexbin` and plotting with a logarithmic color scale, the colorbar
281+
When using `~.Axes.hexbin` and plotting with a logarithmic color scale, the colorbar
282282
ticks are now correctly log scaled. Previously the tick values were linear
283283
scaled log(number of counts).
284284

@@ -292,10 +292,11 @@ regardless of the default color. However, this means that there is no way to
292292
fall back on the default color of the renderer.
293293

294294

295-
Blacklisted rcparams no longer updated by `rcdefaults`, `rc_file_defaults`, `rc_file`
296-
-------------------------------------------------------------------------------------
295+
Blacklisted rcparams no longer updated by `~matplotlib.rcdefaults`, `~matplotlib.rc_file_defaults`, `~matplotlib.rc_file`
296+
-------------------------------------------------------------------------------------------------------------------------
297297

298-
The rc modifier functions `rcdefaults`, `rc_file_defaults` and `rc_file`
298+
The rc modifier functions `~matplotlib.rcdefaults`,
299+
`~matplotlib.rc_file_defaults` and `~matplotlib.rc_file`
299300
now ignore rcParams in the `matplotlib.style.core.STYLE_BLACKLIST` set. In
300301
particular, this prevents the ``backend`` and ``interactive`` rcParams from
301302
being incorrectly modified by these functions.
@@ -328,7 +329,7 @@ Return type of ArtistInspector.get_aliases changed
328329
was used to simulate a set in earlier versions of Python. It has now been
329330
replaced by a set, i.e. ``{fullname: {alias1, alias2, ...}}``.
330331

331-
This value is also stored in `ArtistInspector.aliasd`, which has likewise
332+
This value is also stored in `.ArtistInspector.aliasd`, which has likewise
332333
changed.
333334

334335

@@ -349,10 +350,10 @@ Modules
349350
```````
350351
The following modules are deprecated:
351352

352-
- :mod:`matplotlib.compat.subprocess`. This was a python 2 workaround, but all
353+
- ``matplotlib.compat.subprocess``. This was a python 2 workaround, but all
353354
the functionality can now be found in the python 3 standard library
354355
:mod:`subprocess`.
355-
- :mod:`matplotlib.backends.wx_compat`. Python 3 is only compatible with
356+
- ``matplotlib.backends.wx_compat``. Python 3 is only compatible with
356357
wxPython 4, so support for wxPython 3 or earlier can be dropped.
357358

358359
Classes, methods, functions, and attributes
@@ -382,7 +383,7 @@ The following classes, methods, functions, and attributes are deprecated:
382383
- ``font_manager.TempCache``
383384
- ``image._ImageBase.iterpnames``, use the ``interpolation_names`` property
384385
instead. (this affects classes that inherit from ``_ImageBase`` including
385-
:class:`FigureImage`, :class:`BboxImage`, and :class:`AxesImage`)
386+
`.FigureImage`, `.BboxImage`, and `.AxesImage`)
386387
- ``mathtext.unichr_safe`` (use ``chr`` instead)
387388
- ``patches.Polygon.xy``
388389
- ``table.Table.get_child_artists`` (use ``get_children`` instead)
@@ -395,7 +396,7 @@ The following classes, methods, functions, and attributes are deprecated:
395396
- ``FigureCanvasWx.macros``
396397
- ``_ImageBase.iterpnames``, use the ``interpolation_names`` property instead.
397398
(this affects classes that inherit from ``_ImageBase`` including
398-
:class:`FigureImage`, :class:`BboxImage`, and :class:`AxesImage`)
399+
`.FigureImage`, `.BboxImage`, and `.AxesImage`)
399400
- ``patches.Polygon.xy``
400401
- ``texmanager.dvipng_hack_alpha``
401402
- ``text.Annotation.arrow``

doc/api/prev_api_changes/api_changes_3.0.1.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ subplotparams will collapse axes to zero width or height. This prevents
99
To improve import (startup) time, private modules are now imported lazily.
1010
These modules are no longer available at these locations:
1111

12-
- `matplotlib.backends.backend_agg._png`
13-
- `matplotlib.contour._contour`
14-
- `matplotlib.image._png`
15-
- `matplotlib.mathtext._png`
16-
- `matplotlib.testing.compare._png`
17-
- `matplotlib.texmanager._png`
18-
- `matplotlib.tri.triangulation._tri`
19-
- `matplotlib.tri.triangulation._qhull`
20-
- `matplotlib.tri.tricontour._tri`
21-
- `matplotlib.tri.trifinder._tri`
12+
- ``matplotlib.backends.backend_agg._png``
13+
- ``matplotlib.contour._contour``
14+
- ``matplotlib.image._png``
15+
- ``matplotlib.mathtext._png``
16+
- ``matplotlib.testing.compare._png``
17+
- ``matplotlib.texmanager._png``
18+
- ``matplotlib.tri.triangulation._tri``
19+
- ``matplotlib.tri.triangulation._qhull``
20+
- ``matplotlib.tri.tricontour._tri``
21+
- ``matplotlib.tri.trifinder._tri``

doc/api/prev_api_changes/api_changes_3.1.0.rst

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ Invalid points in PathCollections
2929
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3030
PathCollections created with `~.Axes.scatter` now keep track of invalid points.
3131
Previously, points with nonfinite (infinite or nan) coordinates would not be
32-
included in the offsets (as returned by `PathCollection.get_offsets`) of a
33-
`PathCollection` created by `~.Axes.scatter`, and points with nonfinite values
32+
included in the offsets (as returned by `.PathCollection.get_offsets`) of a
33+
`.PathCollection` created by `~.Axes.scatter`, and points with nonfinite values
3434
(as specified by the *c* kwarg) would not be included in the array (as returned
35-
by `PathCollection.get_array`)
35+
by `.PathCollection.get_array`)
3636

3737
Such points are now included, but masked out by returning a masked array.
3838

@@ -56,9 +56,9 @@ instead of adding a decade only to the right.
5656

5757
Log-scaled axes
5858
~~~~~~~~~~~~~~~
59-
When the default `LogLocator` would generate no ticks for an axis (e.g., an
59+
When the default `.LogLocator` would generate no ticks for an axis (e.g., an
6060
axis with limits from 0.31 to 0.39) or only a single tick, it now instead falls
61-
back on the linear `AutoLocator` to pick reasonable tick positions.
61+
back on the linear `.AutoLocator` to pick reasonable tick positions.
6262

6363
`.Figure.add_subplot` with no arguments
6464
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -124,7 +124,7 @@ would be::
124124

125125
usetex support
126126
~~~~~~~~~~~~~~
127-
Previously, if :rc:`text.usetex` was True, then constructing a `TextPath` on
127+
Previously, if :rc:`text.usetex` was True, then constructing a `.TextPath` on
128128
a non-mathtext string with ``usetex=False`` would rely on the mathtext parser
129129
(but not on usetex support!) to parse the string. The mathtext parser is not
130130
invoked anymore, which may cause slight changes in glyph positioning.
@@ -247,9 +247,9 @@ return 2 lists of histogram values. Previously, a single list was returned.
247247
`.backend_bases.Timer.remove_callback` future signature change
248248
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
249249

250-
Currently, `.backend_bases.Timer.remove_callback(func, *args,
251-
**kwargs)` removes a callback previously added by
252-
`.backend_bases.Timer.add_callback(func, *args, **kwargs)`, but if
250+
Currently, ``backend_bases.Timer.remove_callback(func, *args,
251+
**kwargs)`` removes a callback previously added by
252+
``backend_bases.Timer.add_callback(func, *args, **kwargs)``, but if
253253
``*args, **kwargs`` is not passed in (ex,
254254
``Timer.remove_callback(func)``), then the first callback with a
255255
matching ``func`` is removed, regardless of whether it was added with
@@ -277,7 +277,7 @@ The new API is modelled after `atexit.register` / `atexit.unregister`.
277277
`~.collections.LineCollection` object instead of a list of
278278
`~.lines.Line2D` objects for stem lines plotted using
279279
`~.Axes.stem`. This gives a very large performance boost to displaying
280-
and moving `~Axes.stem` plots.
280+
and moving `~.Axes.stem` plots.
281281

282282
This will become the default behaviour in Matplotlib 3.3. To use it
283283
now, the *use_line_collection* keyword argument to `~.Axes.stem` can
@@ -299,7 +299,7 @@ retrieve the collection properties.
299299
`.cm.ScalarMappable`. This inheritance lead to a confusing situation
300300
where the `.cm.ScalarMappable` passed to `matplotlib.colorbar.Colorbar`
301301
(`~.Figure.colorbar`) had a ``set_norm`` method, as did the colorbar.
302-
The colorbar is now purely a follower to the `ScalarMappable` norm and
302+
The colorbar is now purely a follower to the `.ScalarMappable` norm and
303303
colormap, and the old inherited methods
304304
`~matplotlib.colorbar.ColorbarBase.set_norm`,
305305
`~matplotlib.colorbar.ColorbarBase.set_cmap`,
@@ -364,7 +364,7 @@ them.
364364
Furthermore, `.Axes.spy` spy does now allow for an *extent* argument
365365
(was silently ignored so far).
366366

367-
A bug with `.Axes.spy(..., origin='lower')` is fixed. Previously this
367+
A bug with ``Axes.spy(..., origin='lower')`` is fixed. Previously this
368368
flipped the data but not the y-axis resulting in a mismatch between
369369
axes labels and actual data indices. Now, *origin='lower'* flips both
370370
the data and the y-axis labels.
@@ -383,7 +383,7 @@ limits, ticks, and tick labels.
383383

384384
MouseEvents
385385
~~~~~~~~~~~
386-
MouseEvents now include the event name in their `str()`.
386+
MouseEvents now include the event name in their ``str()``.
387387
Previously they contained the prefix "MPL MouseEvent".
388388

389389
RGBA buffer return type
@@ -411,8 +411,8 @@ non-callable), the exception would be silently ignored and the default
411411
formatter be used instead. This is no longer the case; the exception
412412
is now propagated out.
413413

414-
Deprecation of redundant `Tick` attributes
415-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
414+
Deprecation of redundant `.Tick` attributes
415+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
416416

417417
The ``gridOn``, ``tick1On``, ``tick2On``, ``label1On``, and ``label2On``
418418
`~.Tick` attributes have been deprecated. Directly get and set the visibility
@@ -734,7 +734,7 @@ Deprecations
734734
- The ``\stackrel`` mathtext command hsa been deprecated (it behaved differently
735735
from LaTeX's ``\stackrel``. To stack two mathtext expressions, use
736736
``\genfrac{left-delim}{right-delim}{fraction-bar-thickness}{}{top}{bottom}``.
737-
- The `\mathcircled` mathtext command (which is not a real TeX command)
737+
- The ``\mathcircled`` mathtext command (which is not a real TeX command)
738738
is deprecated. Directly use unicode characters (e.g.
739739
``"\N{CIRCLED LATIN CAPITAL LETTER A}"`` or ``"\u24b6"``) instead.
740740
- Support for setting :rc:`mathtext.default` to circled is deprecated.
@@ -796,7 +796,7 @@ Changes in parameter names
796796
as a keyword argument. The common usage pattern as a positional argument
797797
``matplotlib.use('Qt5Agg')`` is not affected.
798798
- The *normed* parameter to `Axes.hist2d` has been renamed to *density*.
799-
- The *s* parameter to `Annotation` (and indirectly `Axes.annotation`) has
799+
- The *s* parameter to `.Annotation` (and indirectly `Axes.annotation`) has
800800
been renamed to *text*.
801801
- The *tolerence* parameter to
802802
`bezier.find_bezier_t_intersecting_with_closedpath`,
@@ -946,7 +946,7 @@ Testing
946946

947947
- ``matplotlib.testing.decorators.switch_backend`` decorator
948948

949-
Test functions should use `pytest.mark.backend(...)`, and the mark will be
949+
Test functions should use ``pytest.mark.backend``, and the mark will be
950950
picked up by the `matplotlib.testing.conftest.mpl_test_settings` fixture.
951951

952952
Quiver
@@ -998,7 +998,7 @@ Transforms / scales
998998
- ``InvertedLog2Transform``
999999
- ``InvertedNaturalLogTransform``
10001000

1001-
These classes defined in :mod:`matplotlib.scales` are deprecated.
1001+
These classes defined in :mod:`matplotlib.scale` are deprecated.
10021002
As a replacement, use the general `LogTransform` and `InvertedLogTransform`
10031003
classes, whose constructors take a *base* argument.
10041004

@@ -1069,7 +1069,7 @@ Environmental Variables
10691069
Axis
10701070
~~~~
10711071

1072-
- `.Axis.iter_ticks`
1072+
- ``Axis.iter_ticks``
10731073

10741074
This only served as a helper to the private `.Axis._update_ticks`
10751075

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ an axis limit did not coincide with a sticky edge, it cannot *cross* a sticky
171171
edge through margin application -- instead, the margins will only expand the
172172
axis limit until it bumps against the sticky edge.
173173

174-
This change improves the margins of axes displaying a `~Axes.streamplot`:
174+
This change improves the margins of axes displaying a `~.Axes.streamplot`:
175175

176176
- if the streamplot goes all the way to the edges of the vector field, then the
177177
axis limits are set to match exactly the vector field limits (whereas they
@@ -201,9 +201,9 @@ that Times New Roman Bold is now correctly detected as bold, not normal weight.
201201

202202
Color-like checking
203203
~~~~~~~~~~~~~~~~~~~
204-
`matplotlib.color.is_colorlike()` used to return True for all string
204+
`matplotlib.colors.is_color_like` used to return True for all string
205205
representations of floats. However, only those with values in 0-1 are valid
206-
colors (representing grayscale values). ``is_colorlike()`` now returns False
206+
colors (representing grayscale values). `.is_color_like` now returns False
207207
for string representations of floats outside 0-1.
208208

209209
Default image interpolation
@@ -243,7 +243,7 @@ for better readability.
243243

244244
``add_subplot()``
245245
~~~~~~~~~~~~~~~~~
246-
`.Figure.add_subplot()` and `.pyplot.subplot()` do not accept a `figure`
246+
`.Figure.add_subplot()` and `.pyplot.subplot()` do not accept a *figure*
247247
keyword argument anymore. It only used to work anyway if the passed figure
248248
was ``self`` or the current figure, respectively.
249249

doc/api/prev_api_changes/api_changes_3.2.0/development.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Development changes
33

44
Windows build
55
~~~~~~~~~~~~~
6-
Previously, when building the :mod:`matplotlib._png` extension, the build
6+
Previously, when building the ``matplotlib._png`` extension, the build
77
script would add "png" and "z" to the extensions ``.libraries`` attribute (if
88
pkg-config information is not available, which is in particular the case on
99
Windows).

doc/devel/MEP/MEP10.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ There should instead be short summary tables that link to detailed
3030
documentation. In addition, some of the docstrings themselves are
3131
quite long and contain redundant information.
3232

33-
Building the documentation takes a long time and uses a `make.py`
33+
Building the documentation takes a long time and uses a :file:`make.py`
3434
script rather than a Makefile.
3535

3636
Detailed description
@@ -163,17 +163,17 @@ Implementation
163163
This should hopefully have minimal impact on the narrative
164164
documentation.
165165

166-
4. Modify the example page generator (`gen_rst.py`) so that it
166+
4. Modify the example page generator (:file:`gen_rst.py`) so that it
167167
extracts the module docstring from the example and includes it in a
168168
non-literal part of the example page.
169169

170170
5. Use `sphinx-quickstart` to generate a new-style Sphinx Makefile.
171-
The following features in the current `make.py` will have to be
171+
The following features in the current :file:`make.py` will have to be
172172
addressed in some other way:
173173

174-
- Copying of some static content
174+
- Copying of some static content
175175

176-
- Specifying a "small" build (only low-resolution PNG files for examples)
176+
- Specifying a "small" build (only low-resolution PNG files for examples)
177177

178178
Steps 1, 2, and 3 are interdependent. 4 and 5 may be done
179179
independently, though 5 has some dependency on 3.

doc/devel/MEP/MEP11.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,11 +137,11 @@ ordered from best/hardest to worst/easiest):
137137
our installer, but use the post-install-script to install them
138138
*only* if they can not already be found.
139139

140-
3. Move all of these packages inside a (new) `matplotlib.extern`
140+
3. Move all of these packages inside a (new) ``matplotlib.extern``
141141
namespace so it is clear for outside users that these are
142142
external packages. Add some conditional imports in the core
143143
matplotlib codebase so dateutil_ (at the top-level) is tried
144-
first, and failing that `matplotlib.extern.dateutil` is used.
144+
first, and failing that ``matplotlib.extern.dateutil`` is used.
145145

146146
2 and 3 are undesirable as they still require maintaining copies of
147147
these packages in our tree -- and this is exacerbated by the fact that

0 commit comments

Comments
 (0)