Skip to content

Commit 340f51e

Browse files
committed
More fully qualified argument types
1 parent c0d9c98 commit 340f51e

File tree

7 files changed

+24
-18
lines changed

7 files changed

+24
-18
lines changed

lib/matplotlib/artist.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -715,7 +715,7 @@ def set_path_effects(self, path_effects):
715715
716716
Parameters
717717
----------
718-
path_effects : `.AbstractPathEffect`
718+
path_effects : `~matplotlib.patheffects.AbstractPathEffect`
719719
"""
720720
self._path_effects = path_effects
721721
self.stale = True

lib/matplotlib/axes/_axes.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -1991,7 +1991,7 @@ def acorr(self, x, **kwargs):
19911991
The lag vector.
19921992
c : array (length ``2*maxlags+1``)
19931993
The auto correlation vector.
1994-
line : `.LineCollection` or `.Line2D`
1994+
line : `~matplotlib.collections.LineCollection` or `~matplotlib.lines.Line2D`
19951995
`.Artist` added to the Axes of the correlation:
19961996
19971997
- `.LineCollection` if *usevlines* is True.
@@ -2068,7 +2068,7 @@ def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none,
20682068
The lag vector.
20692069
c : array (length ``2*maxlags+1``)
20702070
The auto correlation vector.
2071-
line : `.LineCollection` or `.Line2D`
2071+
line : `~matplotlib.collections.LineCollection` or `~matplotlib.lines.Line2D`
20722072
`.Artist` added to the Axes of the correlation:
20732073
20742074
- `.LineCollection` if *usevlines* is True.
@@ -2706,7 +2706,7 @@ def bar_label(self, container, labels=None, *, fmt="%g", label_type="edge",
27062706
27072707
Parameters
27082708
----------
2709-
container : `.BarContainer`
2709+
container : `~matplotlib.container.BarContainer`
27102710
Container with all the bars and optionally errorbars, likely
27112711
returned from `.bar` or `.barh`.
27122712
@@ -6703,8 +6703,8 @@ def hist(self, x, bins=None, range=None, density=False, weights=None,
67036703
edge of last bin). Always a single array even when multiple data
67046704
sets are passed in.
67056705
6706-
patches : `.BarContainer` or list of a single `.Polygon` or list of \
6707-
such objects
6706+
patches : `~matplotlib.container.BarContainer` or list of a single \
6707+
`~matplolib.patches.Polygon` or list of such objects
67086708
Container of individual artists used to create the histogram
67096709
or list of such containers if there are multiple input datasets.
67106710

lib/matplotlib/axes/_base.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -4143,7 +4143,7 @@ def start_pan(self, x, y, button):
41434143
----------
41444144
x, y : float
41454145
The mouse coordinates in display coords.
4146-
button : `.MouseButton`
4146+
button : `~matplotlib.backend_bases.MouseButton`
41474147
The pressed mouse button.
41484148
41494149
Notes
@@ -4236,7 +4236,7 @@ def drag_pan(self, button, key, x, y):
42364236
42374237
Parameters
42384238
----------
4239-
button : `.MouseButton`
4239+
button : `~matplotlib.backend_bases.MouseButton`
42404240
The pressed mouse button.
42414241
key : str or None
42424242
The pressed key, if any.

lib/matplotlib/cm.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -394,7 +394,7 @@ def __init__(self, norm=None, cmap=None):
394394
"""
395395
Parameters
396396
----------
397-
norm : `.Normalize` (or subclass thereof) or str or None
397+
norm : `~matplotlib.colors.Normalize` (or subclass thereof) or str or None
398398
The normalizing object which scales data, typically into the
399399
interval ``[0, 1]``.
400400
If a `str`, a `.Normalize` subclass is dynamically generated based
@@ -640,7 +640,7 @@ def set_norm(self, norm):
640640
641641
Parameters
642642
----------
643-
norm : `.Normalize` or str or None
643+
norm : `~matplotlib.colors.Normalize` or str or None
644644
645645
Notes
646646
-----

lib/matplotlib/dates.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -667,7 +667,7 @@ class ConciseDateFormatter(ticker.Formatter):
667667
668668
Parameters
669669
----------
670-
locator : `.ticker.Locator`
670+
locator : `~matplotlib.ticker.Locator`
671671
Locator that this axis is using.
672672
673673
tz : str or `~datetime.tzinfo`, default: :rc:`timezone`
@@ -940,7 +940,7 @@ def __init__(self, locator, tz=None, defaultfmt='%Y-%m-%d', *,
940940
941941
Parameters
942942
----------
943-
locator : `.ticker.Locator`
943+
locator : `~matplotlib.ticker.Locator`
944944
Locator that this axis is using.
945945
946946
tz : str or `~datetime.tzinfo`, default: :rc:`timezone`

lib/matplotlib/figure.py

+6-3
Original file line numberDiff line numberDiff line change
@@ -3420,11 +3420,14 @@ def ginput(self, n=1, timeout=30, show_clicks=True,
34203420
will never time out.
34213421
show_clicks : bool, default: True
34223422
If True, show a red cross at the location of each click.
3423-
mouse_add : `.MouseButton` or None, default: `.MouseButton.LEFT`
3423+
mouse_add : `~matplotlib.backend_bases.MouseButton` or None, default: \
3424+
`.MouseButton.LEFT`
34243425
Mouse button used to add points.
3425-
mouse_pop : `.MouseButton` or None, default: `.MouseButton.RIGHT`
3426+
mouse_pop : `~matplotlib.backend_bases.MouseButton` or None, default: \
3427+
`.MouseButton.RIGHT`
34263428
Mouse button used to remove the most recently added point.
3427-
mouse_stop : `.MouseButton` or None, default: `.MouseButton.MIDDLE`
3429+
mouse_stop : `~matplotlib.backend_bases.MouseButton` or None, default: \
3430+
`.MouseButton.MIDDLE`
34283431
Mouse button used to stop input.
34293432
34303433
Returns

lib/matplotlib/widgets.py

+6-3
Original file line numberDiff line numberDiff line change
@@ -2584,7 +2584,8 @@ def on_select(min: float, max: float) -> Any
25842584
Whether to draw a set of handles that allow interaction with the
25852585
widget after it is drawn.
25862586
2587-
button : `.MouseButton` or list of `.MouseButton`, default: all buttons
2587+
button : `~matplotlib.backend_bases.MouseButton` or list of \
2588+
`~matplotlib.backend_bases.MouseButton`, default: all buttons
25882589
The mouse buttons which activate the span selector.
25892590
25902591
handle_props : dict, default: None
@@ -3170,7 +3171,8 @@ def onselect(eclick: MouseEvent, erelease: MouseEvent)
31703171
Whether to interpret *minspanx* and *minspany* in data or in pixel
31713172
coordinates.
31723173
3173-
button : `.MouseButton`, list of `.MouseButton`, default: all buttons
3174+
button : `~matplotlib.backend_bases.MouseButton`, list of \
3175+
`~matplotlib.backend_bases.MouseButton`, default: all buttons
31743176
Button(s) that trigger rectangle selection.
31753177
31763178
grab_range : float, default: 10
@@ -3781,7 +3783,8 @@ def onselect(verts):
37813783
props : dict, optional
37823784
Properties with which the line is drawn, see `matplotlib.lines.Line2D`
37833785
for valid properties. Default values are defined in ``mpl.rcParams``.
3784-
button : `.MouseButton` or list of `.MouseButton`, optional
3786+
button : `~matplotlib.backend_bases.MouseButton` or list of \
3787+
`~matplotlib.backend_bases.MouseButton`, optional
37853788
The mouse buttons used for rectangle selection. Default is ``None``,
37863789
which corresponds to all buttons.
37873790
"""

0 commit comments

Comments
 (0)