Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 7e99594

Browse files
KojoleyKojoley
authored
And more missing refs. (#16229)
And more missing refs.
2 parents cc8b594 + f0b900d commit 7e99594

25 files changed

+77
-195
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The deprecated and not fully functional CocoaAgg backend has been removed.
3232
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3333
The TkAgg backend had its own implementation of the `round` function. This
3434
was unused internally and has been removed. Instead, use either the
35-
`round` builtin function or `numpy.round`.
35+
`round` builtin function or `numpy.around`.
3636

3737
.. _v200_deprecate_hold:
3838

‎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
@@ -144,7 +144,7 @@ now raise ``TypeError`` because ``**kwargs`` has been removed.
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.
147-
- :meth:`mpl_toolkits.axes_grid1.axes_divider.SubPlotDivider` raises
147+
- `mpl_toolkits.axes_grid1.axes_divider.SubplotDivider` raises
148148
``TypeError`` instead of ``Exception`` when passed unknown kwargs.
149149

150150

@@ -400,10 +400,10 @@ The following classes, methods, functions, and attributes are deprecated:
400400
- ``patches.Polygon.xy``
401401
- ``texmanager.dvipng_hack_alpha``
402402
- ``text.Annotation.arrow``
403-
- `.Legend.draggable()`, in favor of `.Legend.set_draggable()`
403+
- ``Legend.draggable()``, in favor of `.Legend.set_draggable()`
404404
(``Legend.draggable`` may be reintroduced as a property in future releases)
405405
- ``textpath.TextToPath.tex_font_map``
406-
- :class:`matplotlib.cbook.deprecation.mplDeprecation` will be removed
406+
- ``matplotlib.cbook.deprecation.mplDeprecation`` will be removed
407407
in future versions. It is just an alias for
408408
:class:`matplotlib.cbook.deprecation.MatplotlibDeprecationWarning`.
409409
Please use the

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@ FreeType or libpng are not in the compiler or linker's default path, set the
316316
standard environment variables ``CFLAGS``/``LDFLAGS`` on Linux or OSX, or
317317
``CL``/``LINK`` on Windows, to indicate the relevant paths.
318318

319-
See details in `Installing`.
319+
See details in :doc:`/users/installing`.
320320

321321
Setting artist properties twice or more in the same call
322322
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -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.annotate`) has
800800
been renamed to *text*.
801801
- The *tolerence* parameter to
802802
`bezier.find_bezier_t_intersecting_with_closedpath`,

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ axes and axis
1919
Setting ``Axis.major.locator``, ``Axis.minor.locator``, ``Axis.major.formatter``
2020
or ``Axis.minor.formatter`` to an object that is not a subclass of `.Locator` or
2121
`.Formatter` (respectively) is deprecated. Note that these attributes should
22-
usually be set using `Axis.set_major_locator`, `Axis.set_minor_locator`, etc.
22+
usually be set using `.Axis.set_major_locator`, `.Axis.set_minor_locator`, etc.
2323
which already raise an exception when an object of the wrong class is passed.
2424

2525
Passing more than one positional argument or unsupported keyword arguments to
@@ -89,9 +89,9 @@ Axes3D
8989
axisartist
9090
~~~~~~~~~~
9191
``mpl_toolkits.axisartist.grid_finder.GridFinderBase`` is deprecated (its
92-
only use is to be inherited by the `GridFinder` class which just provides
92+
only use is to be inherited by the `.GridFinder` class which just provides
9393
more defaults in the constructor and directly sets the transforms, so
94-
``GridFinderBase``'s methods were just moved to `GridFinder`).
94+
``GridFinderBase``'s methods were just moved to `.GridFinder`).
9595

9696
``axisartist.axis_artist.BezierPath`` is deprecated (use `.patches.PathPatch`
9797
to draw arbitrary Paths).

‎doc/devel/MEP/MEP10.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ reason, many matplotlib methods include something like::
8585
"""
8686

8787
This can't be parsed by Sphinx, and is rather verbose in raw text. As
88-
of Sphinx 1.1, if the `autodoc_docstring_signature` config value is
88+
of Sphinx 1.1, if the ``autodoc_docstring_signature`` config value is
8989
set to True, Sphinx will extract a replacement signature from the
9090
first line of the docstring, allowing this::
9191

‎doc/devel/MEP/MEP12.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ page instead of the gallery examples.
139139

140140
**Note:** When moving an existing example, you should search for
141141
references to that example. For example, the API documentation for
142-
`axes.py` and `pyplot.py` may use these examples to generate
142+
:file:`axes.py` and :file:`pyplot.py` may use these examples to generate
143143
plots. Use your favorite search tool (e.g., grep, ack, `grin
144144
<https://pypi.python.org/pypi/grin>`_, `pss
145145
<https://pypi.python.org/pypi/pss>`_) to search the matplotlib

‎doc/devel/MEP/MEP26.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Implementation
6868
It will be easiest to allow a '3rd party' to modify/set the style of
6969
an artist if the 'style' is created as a separate class and store
7070
against the artist as a property. The `.GraphicsContext` class already
71-
provides a the basis of a `Style` class and an artists `draw` method can
71+
provides a the basis of a `Style` class and an artist's `~.Artist.draw` method can
7272
be refactored to use the `Style` class rather than setting up it's own
7373
`.GraphicsContext` and transferring it's style-related properties to
7474
it. A minimal example of how this could be implemented is shown here:

‎doc/devel/contributing.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,8 @@ API changes
296296
Changes to the public API must follow a standard deprecation procedure to
297297
prevent unexpected breaking of code that uses Matplotlib.
298298

299-
- Deprecations must be announced via an entry in `doc/api/next_api_changes`.
299+
- Deprecations must be announced via an entry in
300+
:file:`doc/api/next_api_changes`.
300301
- Deprecations are targeted at the next point-release (i.e. 3.x.0).
301302
- The deprecated API should, to the maximum extent possible, remain fully
302303
functional during the deprecation period. In cases where this is not

‎doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ scatterplots, etc., with just a few lines of code. For examples, see the
4141
:doc:`sample plots <tutorials/introductory/sample_plots>` and :doc:`thumbnail
4242
gallery <gallery/index>`.
4343

44-
For simple plotting the `pyplot` module provides a MATLAB-like interface,
44+
For simple plotting the :mod:`.pyplot` module provides a MATLAB-like interface,
4545
particularly when combined with IPython. For the power user, you have full
4646
control of line styles, font properties, axes properties, etc, via an object
4747
oriented interface or via a set of functions familiar to MATLAB users.

0 commit comments

Comments
 (0)