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

Skip to content

Commit 333fbff

Browse files
anntzerMeeseeksDev[bot]
anntzer
authored and
MeeseeksDev[bot]
committed
Backport PR #10551: Simplify rst cross references by omitting the shortener ~ when not needed
1 parent 03f6c44 commit 333fbff

16 files changed

Lines changed: 107 additions & 107 deletions

File tree

‎lib/matplotlib/artist.py‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -306,8 +306,8 @@ def set_transform(self, t):
306306
307307
Parameters
308308
----------
309-
t : `~.Transform`
310-
.. ACCEPTS: `~.Transform`
309+
t : `.Transform`
310+
.. ACCEPTS: `.Transform`
311311
"""
312312
self._transform = t
313313
self._transformSet = True
@@ -469,7 +469,7 @@ def get_picker(self):
469469

470470
@cbook.deprecated("2.2", "artist.figure is not None")
471471
def is_figure_set(self):
472-
"""Returns whether the artist is assigned to a `~.Figure`."""
472+
"""Returns whether the artist is assigned to a `.Figure`."""
473473
return self.figure is not None
474474

475475
def get_url(self):
@@ -596,8 +596,8 @@ def set_path_effects(self, path_effects):
596596
597597
Parameters
598598
----------
599-
path_effects : `~.AbstractPathEffect`
600-
.. ACCEPTS: `~.AbstractPathEffect`
599+
path_effects : `.AbstractPathEffect`
600+
.. ACCEPTS: `.AbstractPathEffect`
601601
"""
602602
self._path_effects = path_effects
603603
self.stale = True
@@ -606,17 +606,17 @@ def get_path_effects(self):
606606
return self._path_effects
607607

608608
def get_figure(self):
609-
"""Return the `~.Figure` instance the artist belongs to."""
609+
"""Return the `.Figure` instance the artist belongs to."""
610610
return self.figure
611611

612612
def set_figure(self, fig):
613613
"""
614-
Set the `~.Figure` instance the artist belongs to.
614+
Set the `.Figure` instance the artist belongs to.
615615
616616
Parameters
617617
----------
618-
fig : `~.Figure`
619-
.. ACCEPTS: a `~.Figure` instance
618+
fig : `.Figure`
619+
.. ACCEPTS: a `.Figure` instance
620620
"""
621621
# if this is a no-op just return
622622
if self.figure is fig:
@@ -636,12 +636,12 @@ def set_figure(self, fig):
636636

637637
def set_clip_box(self, clipbox):
638638
"""
639-
Set the artist's clip `~.Bbox`.
639+
Set the artist's clip `.Bbox`.
640640
641641
Parameters
642642
----------
643-
clipbox : `~.Bbox`
644-
.. ACCEPTS: a `~.Bbox` instance
643+
clipbox : `.Bbox`
644+
.. ACCEPTS: a `.Bbox` instance
645645
"""
646646
self.clipbox = clipbox
647647
self.pchanged()
@@ -662,7 +662,7 @@ def set_clip_path(self, path, transform=None):
662662
this method will set the clipping box to the corresponding rectangle
663663
and set the clipping path to ``None``.
664664
665-
ACCEPTS: [(`~matplotlib.path.Path`, `~.Transform`) | `~.Patch` | None]
665+
ACCEPTS: [(`~matplotlib.path.Path`, `.Transform`) | `.Patch` | None]
666666
"""
667667
from matplotlib.patches import Patch, Rectangle
668668

‎lib/matplotlib/axes/_axes.py‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,7 @@ def legend(self, *args, **kwargs):
344344
Parameters
345345
----------
346346
347-
handles : sequence of `~.Artist`, optional
347+
handles : sequence of `.Artist`, optional
348348
A list of Artists (lines, patches) to be added to the legend.
349349
Use this together with *labels*, if you need full control on what
350350
is shown in the legend and the automatic mechanism described above
@@ -386,7 +386,7 @@ def legend(self, *args, **kwargs):
386386
corner of the legend in axes coordinates (in which case
387387
``bbox_to_anchor`` will be ignored).
388388
389-
bbox_to_anchor : `~.BboxBase` or pair of floats
389+
bbox_to_anchor : `.BboxBase` or pair of floats
390390
Specify any arbitrary location for the legend in `bbox_transform`
391391
coordinates (default Axes coordinates).
392392
@@ -411,13 +411,13 @@ def legend(self, *args, **kwargs):
411411
412412
numpoints : None or int
413413
The number of marker points in the legend when creating a legend
414-
entry for a `~.Line2D` (line).
414+
entry for a `.Line2D` (line).
415415
Default is ``None``, which will take the value from
416416
:rc:`legend.numpoints`.
417417
418418
scatterpoints : None or int
419419
The number of marker points in the legend when creating
420-
a legend entry for a `~.PathCollection` (scatter plot).
420+
a legend entry for a `.PathCollection` (scatter plot).
421421
Default is ``None``, which will take the value from
422422
:rc:`legend.scatterpoints`.
423423
@@ -1305,7 +1305,7 @@ def plot(self, *args, **kwargs):
13051305
>>> plot(y) # plot y using x as index array 0..N-1
13061306
>>> plot(y, 'r+') # ditto, but with red plusses
13071307
1308-
You can use `~.Line2D` properties as keyword arguments for more
1308+
You can use `.Line2D` properties as keyword arguments for more
13091309
control on the appearance. Line properties and *fmt* can be mixed.
13101310
The following two calls yield identical results:
13111311
@@ -1403,7 +1403,7 @@ def plot(self, *args, **kwargs):
14031403
These parameters determined if the view limits are adapted to
14041404
the data limits. The values are passed on to `autoscale_view`.
14051405
1406-
**kwargs : `~.Line2D` properties, optional
1406+
**kwargs : `.Line2D` properties, optional
14071407
*kwargs* are used to specify properties like a line label (for
14081408
auto legends), linewidth, antialiasing, marker face color.
14091409
Example::
@@ -1414,14 +1414,14 @@ def plot(self, *args, **kwargs):
14141414
If you make multiple lines with one plot command, the kwargs
14151415
apply to all those lines.
14161416
1417-
Here is a list of available `~.Line2D` properties:
1417+
Here is a list of available `.Line2D` properties:
14181418
14191419
%(Line2D)s
14201420
14211421
Returns
14221422
-------
14231423
lines
1424-
A list of `~.Line2D` objects that were added.
1424+
A list of `.Line2D` objects that were added.
14251425
14261426
14271427
See Also
@@ -1800,12 +1800,12 @@ def acorr(self, x, **kwargs):
18001800
lag vector.
18011801
c : array (length ``2*maxlags+1``)
18021802
auto correlation vector.
1803-
line : `~.LineCollection` or `~.Line2D`
1804-
`~.Artist` added to the axes of the correlation.
1803+
line : `.LineCollection` or `.Line2D`
1804+
`.Artist` added to the axes of the correlation.
18051805
1806-
`~.LineCollection` if *usevlines* is True
1807-
`~.Line2D` if *usevlines* is False
1808-
b : `~.Line2D` or None
1806+
`.LineCollection` if *usevlines* is True
1807+
`.Line2D` if *usevlines* is False
1808+
b : `.Line2D` or None
18091809
Horizontal line at 0 if *usevlines* is True
18101810
None *usevlines* is False
18111811
@@ -1862,12 +1862,12 @@ def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none,
18621862
lag vector.
18631863
c : array (length ``2*maxlags+1``)
18641864
auto correlation vector.
1865-
line : `~.LineCollection` or `~.Line2D`
1866-
`~.Artist` added to the axes of the correlation
1865+
line : `.LineCollection` or `.Line2D`
1866+
`.Artist` added to the axes of the correlation
18671867
1868-
`~.LineCollection` if *usevlines* is True
1869-
`~.Line2D` if *usevlines* is False
1870-
b : `~.Line2D` or None
1868+
`.LineCollection` if *usevlines* is True
1869+
`.Line2D` if *usevlines* is False
1870+
b : `.Line2D` or None
18711871
Horizontal line at 0 if *usevlines* is True
18721872
None *usevlines* is False
18731873
@@ -2049,7 +2049,7 @@ def bar(self, *args, **kwargs):
20492049
20502050
Returns
20512051
-------
2052-
`~.BarContainer`
2052+
`.BarContainer`
20532053
Container with all the bars and optionally errorbars.
20542054
20552055
Other Parameters
@@ -2367,7 +2367,7 @@ def barh(self, *args, **kwargs):
23672367
23682368
Returns
23692369
-------
2370-
`~.BarContainer`
2370+
`.BarContainer`
23712371
Container with all the bars and optionally errorbars.
23722372
23732373
Other Parameters
@@ -2485,7 +2485,7 @@ def broken_barh(self, xranges, yrange, **kwargs):
24852485
24862486
Other Parameters
24872487
----------------
2488-
**kwargs : :class:`~.BrokenBarHCollection` properties
2488+
**kwargs : :class:`.BrokenBarHCollection` properties
24892489
24902490
Each *kwarg* can be either a single argument applying to all
24912491
rectangles, e.g.::
@@ -2979,7 +2979,7 @@ def errorbar(self, x, y, yerr=None, xerr=None,
29792979
- *None*: No errorbar.
29802980
29812981
fmt : plot format string, optional, default: ''
2982-
The format for the data points / data lines. See `~.plot` for
2982+
The format for the data points / data lines. See `.plot` for
29832983
details.
29842984
29852985
Use 'none' (case insensitive) to plot errorbars without any data
@@ -3049,7 +3049,7 @@ def errorbar(self, x, y, yerr=None, xerr=None,
30493049
property names, *markerfacecolor*, *markeredgecolor*, *markersize*
30503050
and *markeredgewidth*.
30513051
3052-
Valid kwargs for the marker properties are `~.Lines2D` properties:
3052+
Valid kwargs for the marker properties are `.Lines2D` properties:
30533053
30543054
%(Line2D)s
30553055
@@ -4103,7 +4103,7 @@ def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
41034103
``image.cmap``.
41044104
41054105
norm : `~matplotlib.colors.Normalize`, optional, default: None
4106-
A `~.Normalize` instance is used to scale luminance data to 0, 1.
4106+
A `.Normalize` instance is used to scale luminance data to 0, 1.
41074107
*norm* is only used if *c* is an array of floats. If *None*, use
41084108
the default `.colors.Normalize`.
41094109
@@ -5027,15 +5027,15 @@ def fill_between(self, x, y1, y2=0, where=None, interpolate=False,
50275027
Other Parameters
50285028
----------------
50295029
**kwargs
5030-
All other keyword arguments are passed on to `~.PolyCollection`.
5031-
They control the `~.Polygon` properties:
5030+
All other keyword arguments are passed on to `.PolyCollection`.
5031+
They control the `.Polygon` properties:
50325032
50335033
%(PolyCollection)s
50345034
50355035
Returns
50365036
-------
5037-
`~.PolyCollection`
5038-
A `~.PolyCollection` containing the plotted polygons.
5037+
`.PolyCollection`
5038+
A `.PolyCollection` containing the plotted polygons.
50395039
50405040
See Also
50415041
--------
@@ -5211,15 +5211,15 @@ def fill_betweenx(self, y, x1, x2=0, where=None,
52115211
Other Parameters
52125212
----------------
52135213
**kwargs
5214-
All other keyword arguments are passed on to `~.PolyCollection`.
5215-
They control the `~.Polygon` properties:
5214+
All other keyword arguments are passed on to `.PolyCollection`.
5215+
They control the `.Polygon` properties:
52165216
52175217
%(PolyCollection)s
52185218
52195219
Returns
52205220
-------
5221-
`~.PolyCollection`
5222-
A `~.PolyCollection` containing the plotted polygons.
5221+
`.PolyCollection`
5222+
A `.PolyCollection` containing the plotted polygons.
52235223
52245224
See Also
52255225
--------

‎lib/matplotlib/axes/_base.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -624,13 +624,13 @@ def _init_axis(self):
624624

625625
def set_figure(self, fig):
626626
"""
627-
Set the `~.Figure` for this `~.Axes`.
627+
Set the `.Figure` for this `.Axes`.
628628
629-
.. ACCEPTS: `~.Figure`
629+
.. ACCEPTS: `.Figure`
630630
631631
Parameters
632632
----------
633-
fig : `~.Figure`
633+
fig : `.Figure`
634634
"""
635635
martist.Artist.set_figure(self, fig)
636636

‎lib/matplotlib/cbook/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -620,7 +620,7 @@ def to_filehandle(fname, flag='rU', return_opened=False, encoding=None):
620620

621621
@contextlib.contextmanager
622622
def open_file_cm(path_or_file, mode="r", encoding=None):
623-
r"""Pass through file objects and context-manage `~.PathLike`\s."""
623+
r"""Pass through file objects and context-manage `.PathLike`\s."""
624624
fh, opened = to_filehandle(path_or_file, mode, True, encoding)
625625
if opened:
626626
with fh:

‎lib/matplotlib/cm.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -332,11 +332,11 @@ def set_cmap(self, cmap):
332332
def set_norm(self, norm):
333333
"""Set the normalization instance.
334334
335-
.. ACCEPTS: `~.Normalize`
335+
.. ACCEPTS: `.Normalize`
336336
337337
Parameters
338338
----------
339-
norm : `~.Normalize`
339+
norm : `.Normalize`
340340
"""
341341
if norm is None:
342342
norm = colors.Normalize()

‎lib/matplotlib/dates.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -296,10 +296,10 @@ def _dt64_to_ordinalf(d):
296296
def _from_ordinalf(x, tz=None):
297297
"""
298298
Convert Gregorian float of the date, preserving hours, minutes,
299-
seconds and microseconds. Return value is a `~.datetime`.
299+
seconds and microseconds. Return value is a `.datetime`.
300300
301301
The input date *x* is a float in ordinal days at UTC, and the output will
302-
be the specified `~.datetime` object corresponding to that time in
302+
be the specified `.datetime` object corresponding to that time in
303303
timezone *tz*, or if *tz* is ``None``, in the timezone specified in
304304
:rc:`timezone`.
305305
"""

0 commit comments

Comments
 (0)