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

Skip to content

Commit 6472fb3

Browse files
committed
DOC: more tweaks to ensure links
1 parent bcef5d9 commit 6472fb3

File tree

3 files changed

+20
-17
lines changed

3 files changed

+20
-17
lines changed

doc/api/animation_api.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ The easiest way to make a live animation in matplotlib is to use one of the
2121
:toctree: _as_gen
2222
:nosignatures:
2323

24+
Animation
2425
FuncAnimation
2526
ArtistAnimation
2627

doc/api/matplotlib_configuration_api.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,5 @@
3333
.. autofunction:: interactive
3434

3535
.. autofunction:: is_interactive
36+
37+
.. autofunction:: set_loglevel

doc/users/whats_new.rst

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,9 @@ axes via `.Axes.secondary_xaxis` and `.Axes.secondary_yaxis`. See
7474
`~.scale.FuncScale` for arbitrary axes scales
7575
---------------------------------------------
7676

77-
A new `-.scale.FuncScale` class was added (and `-.scale.FuncTransform`)
77+
A new `~.scale.FuncScale` class was added (and `~.scale.FuncTransform`)
7878
to allow the user to have arbitrary scale transformations without having to
79-
write a new subclass of `-.scale.ScaleBase`. This can be accessed by::
79+
write a new subclass of `~.scale.ScaleBase`. This can be accessed by::
8080

8181
ax.set_yscale('function', functions=(forward, inverse))
8282

@@ -90,11 +90,11 @@ Legend for scatter
9090

9191
A new method for creating legends for scatter plots has been
9292
introduced. Previously, in order to obtain a legend for a
93-
:meth:`-.axes.Axes.scatter` plot, one could either plot several
93+
:meth:`~.axes.Axes.scatter` plot, one could either plot several
9494
scatters, each with an individual label, or create proxy artists to
9595
show in the legend manually. Now,
96-
:class:`-.collections.PathCollection` provides a method
97-
:meth:`-.collections.PathCollection.legend_elements` to obtain the
96+
:class:`~.collections.PathCollection` provides a method
97+
:meth:`~.collections.PathCollection.legend_elements` to obtain the
9898
handles and labels for a scatter plot in an automated way. This makes
9999
creating a legend for a scatter plot as easy as
100100

@@ -131,11 +131,11 @@ now directly forwards to the visibility of the underlying Rectangle artist
131131
--------------------------------------
132132

133133
Matplotlib uses Pillow to handle saving to the JPEG and TIFF formats. The
134-
`-Figure.savefig()` function gained a *pil_kwargs* keyword argument, which can
135-
be used to forward arguments to Pillow's `PIL.Image.save()`.
134+
`~.Figure.savefig()` function gained a *pil_kwargs* keyword argument, which can
135+
be used to forward arguments to Pillow's `pillow.Image.save()`.
136136

137137
The *pil_kwargs* argument can also be used when saving to PNG. In that case,
138-
Matplotlib also uses Pillow's `PIL.Image.save()` instead of going through its
138+
Matplotlib also uses Pillow's `pillow.Image.save()` instead of going through its
139139
own builtin PNG support.
140140

141141

@@ -159,7 +159,7 @@ Axes and Artists
159159
axes_grid1 and axisartist Axes no longer draw spines twice
160160
----------------------------------------------------------
161161

162-
Previously, spines of `axes_grid1` and `axisartist` Axes would be drawn twice,
162+
Previously, spines of `.axes_grid1` and `.axisartist` Axes would be drawn twice,
163163
leading to a "bold" appearance. This is no longer the case.
164164

165165

@@ -178,7 +178,7 @@ changed.
178178
-----------------------------------------------
179179

180180
Alternatively to strings like ``"data"`` or ``"axes fraction"``
181-
`ConnectionPatch` now accepts any `-matplotlib.transforms.Transform`
181+
`ConnectionPatch` now accepts any `~matplotlib.transforms.Transform`
182182
as input for the ``coordsA`` and ``coordsB`` argument. This allows to
183183
draw lines between points defined in different user defined coordinate
184184
systems. Also see the :doc:`Connect Simple01 example
@@ -198,11 +198,11 @@ an existing Line3D.
198198
``Axes3D.voxels`` now shades the resulting voxels
199199
-------------------------------------------------
200200

201-
The :meth:`-mpl_toolkits.mplot3d.Axes3D.voxels` method now takes a
201+
The :meth:`~mpl_toolkits.mplot3d.Axes3D.voxels` method now takes a
202202
*shade* parameter that defaults to `True`. This shades faces based
203203
on their orientation, behaving just like the matching parameters to
204-
:meth:`-mpl_toolkits.mplot3d.Axes3D.trisurf` and
205-
:meth:`-mpl_toolkits.mplot3d.Axes3D.bar3d`. The plot below shows how
204+
:meth:`~mpl_toolkits.mplot3d.Axes3D.trisurf` and
205+
:meth:`~mpl_toolkits.mplot3d.Axes3D.bar3d`. The plot below shows how
206206
this affects the output.
207207

208208
.. plot::
@@ -265,8 +265,8 @@ Default minor tick spacing was changed from 0.625 to 0.5 for major ticks spaced
265265
A public API has been added to `EngFormatter` to control how the
266266
numbers in the ticklabels will be rendered. By default,
267267
``useMathText`` evaluates to
268-
:rc:`rcParams['axes.formatter.use_mathtext']` and ``usetex`` evaluates
269-
to :rc:`rcParams['text.usetex']`.
268+
:rc:`axes.formatter.use_mathtext'` and ``usetex`` evaluates
269+
to :rc:`'text.usetex'`.
270270

271271
If either is `True` then the numbers will be encapsulated by ``$``
272272
signs. When using ``TeX`` this implies that the numbers will be shown
@@ -294,7 +294,7 @@ created with the Qt5 backend.
294294
*progress_callback* argument to `~.Animation.save()`
295295
----------------------------------------------------
296296

297-
The method .FuncAnimation.save() gained an optional
297+
The method `.Animation.save` gained an optional
298298
*progress_callback* argument to notify the saving progress.
299299

300300

@@ -337,7 +337,7 @@ were previously displayed as ``1e+04``.
337337
MouseEvent button attribute is now an IntEnum
338338
---------------------------------------------
339339

340-
The :attr:`button` attribute of `-.MouseEvent` instances can take the values
340+
The :attr:`button` attribute of `~.MouseEvent` instances can take the values
341341
None, 1 (left button), 2 (middle button), 3 (right button), "up" (scroll), and
342342
"down" (scroll). For better legibility, the 1, 2, and 3 values are now
343343
represented using the `IntEnum` class `matplotlib.backend_bases.MouseButton`,

0 commit comments

Comments
 (0)