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

Skip to content

Commit 4dea709

Browse files
committed
Fix markup of See Also sections.
numpydoc does not like entries in See Also sections to be backquoted without an explicit role, but it is able to handle them without backquotes at all (in fact, that format is given in the numpydoc specification). Fix the corresponding docstrings accordingly, and line-wrap them.
1 parent 456e42a commit 4dea709

File tree

3 files changed

+95
-107
lines changed

3 files changed

+95
-107
lines changed

lib/matplotlib/axes/_axes.py

Lines changed: 30 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -6583,15 +6583,15 @@ def psd(self, x, NFFT=None, Fs=None, Fc=None, detrend=None,
65836583
65846584
See Also
65856585
--------
6586-
`specgram`
6587-
`specgram` differs in the default overlap; in not returning
6588-
the mean of the segment periodograms; in returning the times of the
6586+
specgram
6587+
`specgram` differs in the default overlap; in not returning the
6588+
mean of the segment periodograms; in returning the times of the
65896589
segments; and in plotting a colormap instead of a line.
65906590
6591-
`magnitude_spectrum`
6591+
magnitude_spectrum
65926592
`magnitude_spectrum` plots the magnitude spectrum.
65936593
6594-
`csd`
6594+
csd
65956595
`csd` plots the spectral density between two signals.
65966596
"""
65976597
if not self._hold:
@@ -6711,7 +6711,7 @@ def csd(self, x, y, NFFT=None, Fs=None, Fc=None, detrend=None,
67116711
67126712
See Also
67136713
--------
6714-
`psd`
6714+
psd
67156715
`psd` is the equivalent to setting y=x.
67166716
"""
67176717
if not self._hold:
@@ -6801,20 +6801,19 @@ def magnitude_spectrum(self, x, Fs=None, Fc=None, window=None,
68016801
68026802
See Also
68036803
--------
6804-
`psd`
6804+
psd
68056805
`psd` plots the power spectral density.`.
68066806
6807-
`angle_spectrum`
6808-
`angle_spectrum` plots the angles of the corresponding
6809-
frequencies.
6807+
angle_spectrum
6808+
`angle_spectrum` plots the angles of the corresponding frequencies.
68106809
6811-
`phase_spectrum`
6810+
phase_spectrum
68126811
`phase_spectrum` plots the phase (unwrapped angle) of the
68136812
corresponding frequencies.
68146813
6815-
`specgram`
6816-
`specgram` can plot the magnitude spectrum of segments within
6817-
the signal in a colormap.
6814+
specgram
6815+
`specgram` can plot the magnitude spectrum of segments within the
6816+
signal in a colormap.
68186817
"""
68196818
if not self._hold:
68206819
self.cla()
@@ -6896,15 +6895,14 @@ def angle_spectrum(self, x, Fs=None, Fc=None, window=None,
68966895
68976896
See Also
68986897
--------
6899-
`magnitude_spectrum`
6900-
`angle_spectrum` plots the magnitudes of the corresponding
6898+
magnitude_spectrum
6899+
`magnitude_spectrum` plots the magnitudes of the corresponding
69016900
frequencies.
69026901
6903-
`phase_spectrum`
6904-
`phase_spectrum` plots the unwrapped version of this
6905-
function.
6902+
phase_spectrum
6903+
`phase_spectrum` plots the unwrapped version of this function.
69066904
6907-
`specgram`
6905+
specgram
69086906
`specgram` can plot the angle spectrum of segments within the
69096907
signal in a colormap.
69106908
"""
@@ -6976,14 +6974,14 @@ def phase_spectrum(self, x, Fs=None, Fc=None, window=None,
69766974
69776975
See Also
69786976
--------
6979-
`magnitude_spectrum`
6980-
`magnitude_spectrum` plots the magnitudes of the
6981-
corresponding frequencies.
6977+
magnitude_spectrum
6978+
`magnitude_spectrum` plots the magnitudes of the corresponding
6979+
frequencies.
69826980
6983-
`angle_spectrum`
6981+
angle_spectrum
69846982
`angle_spectrum` plots the wrapped version of this function.
69856983
6986-
`specgram`
6984+
specgram
69876985
`specgram` can plot the phase spectrum of segments within the
69886986
signal in a colormap.
69896987
"""
@@ -7164,20 +7162,20 @@ def specgram(self, x, NFFT=None, Fs=None, Fc=None, detrend=None,
71647162
71657163
See Also
71667164
--------
7167-
`psd`
7168-
`psd` differs in the default overlap; in returning the mean
7169-
of the segment periodograms; in not returning times; and in
7170-
generating a line plot instead of colormap.
7165+
psd
7166+
`psd` differs in the default overlap; in returning the mean of the
7167+
segment periodograms; in not returning times; and in generating a
7168+
line plot instead of colormap.
71717169
7172-
`magnitude_spectrum`
7170+
magnitude_spectrum
71737171
A single spectrum, similar to having a single segment when *mode*
71747172
is 'magnitude'. Plots a line instead of a colormap.
71757173
7176-
`angle_spectrum`
7174+
angle_spectrum
71777175
A single spectrum, similar to having a single segment when *mode*
71787176
is 'angle'. Plots a line instead of a colormap.
71797177
7180-
`phase_spectrum`
7178+
phase_spectrum
71817179
A single spectrum, similar to having a single segment when *mode*
71827180
is 'phase'. Plots a line instead of a colormap.
71837181
"""

0 commit comments

Comments
 (0)