Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 8a1cc04

Browse filesBrowse files
timhoffmtimhoffm
authored
Merge pull request #15850 from anntzer/docstrings
Docstrings cleanup in matplotlib.axes
2 parents aa18f5a + be76dcd commit 8a1cc04
Copy full SHA for 8a1cc04

File tree

Expand file treeCollapse file tree

2 files changed

+68
-99
lines changed
Filter options
Expand file treeCollapse file tree

2 files changed

+68
-99
lines changed

‎lib/matplotlib/axes/_axes.py

Copy file name to clipboardExpand all lines: lib/matplotlib/axes/_axes.py
+67-95Lines changed: 67 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -155,15 +155,14 @@ def set_title(self, label, fontdict=None, loc=None, pad=None,
155155
156156
Returns
157157
-------
158-
text : :class:`~matplotlib.text.Text`
158+
text : `.Text`
159159
The matplotlib text instance representing the title
160160
161161
Other Parameters
162162
----------------
163-
**kwargs : `~matplotlib.text.Text` properties
164-
Other keyword arguments are text properties, see
165-
:class:`~matplotlib.text.Text` for a list of valid text
166-
properties.
163+
**kwargs : `.Text` properties
164+
Other keyword arguments are text properties, see `.Text` for a list
165+
of valid text properties.
167166
"""
168167
if loc is None:
169168
loc = rcParams['axes.titlelocation']
@@ -912,13 +911,13 @@ def axline(self, xy1, xy2, **kwargs):
912911
913912
Returns
914913
-------
915-
:class:`~matplotlib.lines.Line2D`
914+
`.Line2D`
916915
917916
Other Parameters
918917
----------------
919918
**kwargs
920-
Valid kwargs are :class:`~matplotlib.lines.Line2D` properties,
921-
with the exception of 'transform':
919+
Valid kwargs are `.Line2D` properties, with the exception of
920+
'transform':
922921
923922
%(_Line2D_docstr)s
924923
@@ -1285,14 +1284,12 @@ def eventplot(self, positions, orientation='horizontal', lineoffsets=1,
12851284
12861285
**kwargs : optional
12871286
Other keyword arguments are line collection properties. See
1288-
:class:`~matplotlib.collections.LineCollection` for a list of
1289-
the valid properties.
1287+
`.LineCollection` for a list of the valid properties.
12901288
12911289
Returns
12921290
-------
1293-
list : A list of :class:`~.collections.EventCollection` objects.
1294-
Contains the :class:`~.collections.EventCollection` that
1295-
were added.
1291+
list : list of `.EventCollection`
1292+
The `.EventCollection` that were added.
12961293
12971294
Notes
12981295
-----
@@ -1961,7 +1958,7 @@ def acorr(self, x, **kwargs):
19611958
19621959
Notes
19631960
-----
1964-
The cross correlation is performed with :func:`numpy.correlate` with
1961+
The cross correlation is performed with `numpy.correlate` with
19651962
``mode = "full"``.
19661963
"""
19671964
return self.xcorr(x, x, **kwargs)
@@ -2031,7 +2028,7 @@ def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none,
20312028
20322029
Notes
20332030
-----
2034-
The cross correlation is performed with :func:`numpy.correlate` with
2031+
The cross correlation is performed with `numpy.correlate` with
20352032
``mode = "full"``.
20362033
"""
20372034
Nx = len(x)
@@ -2597,7 +2594,7 @@ def broken_barh(self, xranges, yrange, **kwargs):
25972594
25982595
Other Parameters
25992596
----------------
2600-
**kwargs : :class:`.BrokenBarHCollection` properties
2597+
**kwargs : `.BrokenBarHCollection` properties
26012598
26022599
Each *kwarg* can be either a single argument applying to all
26032600
rectangles, e.g.::
@@ -2616,7 +2613,7 @@ def broken_barh(self, xranges, yrange, **kwargs):
26162613
26172614
Returns
26182615
-------
2619-
collection : A :class:`~.collections.BrokenBarHCollection`
2616+
collection : `~.collections.BrokenBarHCollection`
26202617
"""
26212618
# process the unit information
26222619
if len(xranges):
@@ -2716,7 +2713,7 @@ def stem(self, *args, linefmt=None, markerfmt=None, basefmt=None, bottom=0,
27162713
27172714
Returns
27182715
-------
2719-
container : :class:`~matplotlib.container.StemContainer`
2716+
container : `.StemContainer`
27202717
The container may be treated like a tuple
27212718
(*markerline*, *stemlines*, *baseline*)
27222719
@@ -2908,15 +2905,14 @@ def pie(self, x, explode=None, labels=None, colors=None,
29082905
Returns
29092906
-------
29102907
patches : list
2911-
A sequence of :class:`matplotlib.patches.Wedge` instances
2908+
A sequence of `matplotlib.patches.Wedge` instances
29122909
29132910
texts : list
2914-
A list of the label :class:`matplotlib.text.Text` instances.
2911+
A list of the label `.Text` instances.
29152912
29162913
autotexts : list
2917-
A list of :class:`~matplotlib.text.Text` instances for the numeric
2918-
labels. This will only be returned if the parameter *autopct* is
2919-
not *None*.
2914+
A list of `.Text` instances for the numeric labels. This will only
2915+
be returned if the parameter *autopct* is not *None*.
29202916
29212917
Notes
29222918
-----
@@ -3141,14 +3137,13 @@ def errorbar(self, x, y, yerr=None, xerr=None,
31413137
31423138
Returns
31433139
-------
3144-
container : :class:`~.container.ErrorbarContainer`
3140+
container : `.ErrorbarContainer`
31453141
The container contains:
31463142
31473143
- plotline: `.Line2D` instance of x, y plot markers and/or line.
31483144
- caplines: A tuple of `.Line2D` instances of the error bar caps.
3149-
- barlinecols: A tuple of
3150-
:class:`~matplotlib.collections.LineCollection` with the
3151-
horizontal and vertical error ranges.
3145+
- barlinecols: A tuple of `.LineCollection` with the horizontal and
3146+
vertical error ranges.
31523147
31533148
Other Parameters
31543149
----------------
@@ -5035,11 +5030,11 @@ def fill(self, *args, data=None, **kwargs):
50355030
50365031
Returns
50375032
-------
5038-
a list of :class:`~matplotlib.patches.Polygon`
5033+
list of `~matplotlib.patches.Polygon`
50395034
50405035
Other Parameters
50415036
----------------
5042-
**kwargs : :class:`~matplotlib.patches.Polygon` properties
5037+
**kwargs : `~matplotlib.patches.Polygon` properties
50435038
50445039
Notes
50455040
-----
@@ -7015,16 +7010,14 @@ def psd(self, x, NFFT=None, Fs=None, Fc=None, detrend=None,
70157010
70167011
See Also
70177012
--------
7018-
:func:`specgram`
7019-
:func:`specgram` differs in the default overlap; in not returning
7020-
the mean of the segment periodograms; in returning the times of the
7021-
segments; and in plotting a colormap instead of a line.
7022-
7023-
:func:`magnitude_spectrum`
7024-
:func:`magnitude_spectrum` plots the magnitude spectrum.
7025-
7026-
:func:`csd`
7027-
:func:`csd` plots the spectral density between two signals.
7013+
specgram
7014+
Differs in the default overlap; in not returning the mean of the
7015+
segment periodograms; in returning the times of the segments; and
7016+
in plotting a colormap instead of a line.
7017+
magnitude_spectrum
7018+
Plots the magnitude spectrum.
7019+
csd
7020+
Plots the spectral density between two signals.
70287021
70297022
Notes
70307023
-----
@@ -7132,8 +7125,7 @@ def csd(self, x, y, NFFT=None, Fs=None, Fc=None, detrend=None,
71327125
71337126
See Also
71347127
--------
7135-
:func:`psd`
7136-
:func:`psd` is the equivalent to setting y=x.
7128+
psd : is equivalent to setting ``y = x``.
71377129
71387130
Notes
71397131
-----
@@ -7224,21 +7216,15 @@ def magnitude_spectrum(self, x, Fs=None, Fc=None, window=None,
72247216
72257217
See Also
72267218
--------
7227-
:func:`psd`
7228-
:func:`psd` plots the power spectral density.`.
7229-
7230-
:func:`angle_spectrum`
7231-
:func:`angle_spectrum` plots the angles of the corresponding
7232-
frequencies.
7233-
7234-
:func:`phase_spectrum`
7235-
:func:`phase_spectrum` plots the phase (unwrapped angle) of the
7236-
corresponding frequencies.
7237-
7238-
:func:`specgram`
7239-
:func:`specgram` can plot the magnitude spectrum of segments within
7240-
the signal in a colormap.
7241-
7219+
psd
7220+
Plots the power spectral density.
7221+
angle_spectrum
7222+
Plots the angles of the corresponding frequencies.
7223+
phase_spectrum
7224+
Plots the phase (unwrapped angle) of the corresponding frequencies.
7225+
specgram
7226+
Can plot the magnitude spectrum of segments within the signal in a
7227+
colormap.
72427228
"""
72437229
if Fc is None:
72447230
Fc = 0
@@ -7308,18 +7294,13 @@ def angle_spectrum(self, x, Fs=None, Fc=None, window=None,
73087294
73097295
See Also
73107296
--------
7311-
:func:`magnitude_spectrum`
7312-
:func:`angle_spectrum` plots the magnitudes of the corresponding
7313-
frequencies.
7314-
7315-
:func:`phase_spectrum`
7316-
:func:`phase_spectrum` plots the unwrapped version of this
7317-
function.
7318-
7319-
:func:`specgram`
7320-
:func:`specgram` can plot the angle spectrum of segments within the
7321-
signal in a colormap.
7322-
7297+
magnitude_spectrum
7298+
Plots the magnitudes of the corresponding frequencies.
7299+
phase_spectrum
7300+
Plots the unwrapped version of this function.
7301+
specgram
7302+
Can plot the angle spectrum of segments within the signal in a
7303+
colormap.
73237304
"""
73247305
if Fc is None:
73257306
Fc = 0
@@ -7380,17 +7361,13 @@ def phase_spectrum(self, x, Fs=None, Fc=None, window=None,
73807361
73817362
See Also
73827363
--------
7383-
:func:`magnitude_spectrum`
7384-
:func:`magnitude_spectrum` plots the magnitudes of the
7385-
corresponding frequencies.
7386-
7387-
:func:`angle_spectrum`
7388-
:func:`angle_spectrum` plots the wrapped version of this function.
7389-
7390-
:func:`specgram`
7391-
:func:`specgram` can plot the phase spectrum of segments within the
7392-
signal in a colormap.
7393-
7364+
magnitude_spectrum
7365+
Plots the magnitudes of the corresponding frequencies.
7366+
angle_spectrum
7367+
Plots the wrapped version of this function.
7368+
specgram
7369+
Can plot the phase spectrum of segments within the signal in a
7370+
colormap.
73947371
"""
73957372
if Fc is None:
73967373
Fc = 0
@@ -7519,9 +7496,7 @@ def specgram(self, x, NFFT=None, Fs=None, Fc=None, detrend=None,
75197496
when a signal is acquired and then filtered and downsampled to
75207497
baseband.
75217498
7522-
cmap
7523-
A :class:`matplotlib.colors.Colormap` instance; if *None*, use
7524-
default determined by rc
7499+
cmap : `.Colormap`, default: :rc:`image.cmap`
75257500
75267501
xextent : *None* or (xmin, xmax)
75277502
The image extent along the x-axis. The default sets *xmin* to the
@@ -7545,25 +7520,22 @@ def specgram(self, x, NFFT=None, Fs=None, Fc=None, detrend=None,
75457520
The times corresponding to midpoints of segments (i.e., the columns
75467521
in *spectrum*).
75477522
7548-
im : instance of class :class:`~matplotlib.image.AxesImage`
7549-
The image created by imshow containing the spectrogram
7523+
im : instance of class `.AxesImage`
7524+
The image created by imshow containing the spectrogram.
75507525
75517526
See Also
75527527
--------
7553-
:func:`psd`
7554-
:func:`psd` differs in the default overlap; in returning the mean
7555-
of the segment periodograms; in not returning times; and in
7556-
generating a line plot instead of colormap.
7557-
7558-
:func:`magnitude_spectrum`
7528+
psd
7529+
Differs in the default overlap; in returning the mean of the
7530+
segment periodograms; in not returning times; and in generating a
7531+
line plot instead of colormap.
7532+
magnitude_spectrum
75597533
A single spectrum, similar to having a single segment when *mode*
75607534
is 'magnitude'. Plots a line instead of a colormap.
7561-
7562-
:func:`angle_spectrum`
7535+
angle_spectrum
75637536
A single spectrum, similar to having a single segment when *mode*
75647537
is 'angle'. Plots a line instead of a colormap.
7565-
7566-
:func:`phase_spectrum`
7538+
phase_spectrum
75677539
A single spectrum, similar to having a single segment when *mode*
75687540
is 'phase'. Plots a line instead of a colormap.
75697541
@@ -7655,7 +7627,7 @@ def spy(self, Z, precision=0, marker=None, markersize=None,
76557627
If *precision* is 0, any non-zero value will be plotted. Otherwise,
76567628
values of :math:`|Z| > precision` will be plotted.
76577629
7658-
For :class:`scipy.sparse.spmatrix` instances, you can also
7630+
For `scipy.sparse.spmatrix` instances, you can also
76597631
pass 'present'. In this case any value present in the array
76607632
will be plotted, even if it is identically zero.
76617633

‎lib/matplotlib/axes/_base.py

Copy file name to clipboardExpand all lines: lib/matplotlib/axes/_base.py
+1-4Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1812,10 +1812,7 @@ def _sci(self, im):
18121812
self._current_image = im
18131813

18141814
def _gci(self):
1815-
"""
1816-
Helper for :func:`~matplotlib.pyplot.gci`;
1817-
do not use elsewhere.
1818-
"""
1815+
"""Helper for `~matplotlib.pyplot.gci`; do not use elsewhere."""
18191816
return self._current_image
18201817

18211818
def has_data(self):

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.