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

Skip to content

Commit e47befa

Browse files
committed
Adapt section ordering to numpydoc standard
1 parent 1e0c25e commit e47befa

1 file changed

Lines changed: 27 additions & 30 deletions

File tree

lib/matplotlib/axes/_axes.py

Lines changed: 27 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -676,6 +676,11 @@ def axhline(self, y=0, xmin=0, xmax=1, **kwargs):
676676
677677
%(Line2D)s
678678
679+
See also
680+
--------
681+
hlines : add horizontal lines in data coordinates
682+
axhspan : add a horizontal span (rectangle) across the axis
683+
679684
Notes
680685
-----
681686
kwargs are passed to :class:`~matplotlib.lines.Line2D` and can be used
@@ -697,12 +702,7 @@ def axhline(self, y=0, xmin=0, xmax=1, **kwargs):
697702
698703
>>> axhline(y=.5, xmin=0.25, xmax=0.75)
699704
700-
See also
701-
--------
702-
hlines : add horizontal lines in data coordinates
703-
axhspan : add a horizontal span (rectangle) across the axis
704705
"""
705-
706706
if "transform" in kwargs:
707707
raise ValueError(
708708
"'transform' is not allowed as a kwarg;"
@@ -2800,10 +2800,7 @@ def pie(self, x, explode=None, labels=None, colors=None,
28002800
-----
28012801
The pie chart will probably look best if the figure and axes are
28022802
square, or the Axes aspect is equal.
2803-
2804-
28052803
"""
2806-
28072804
x = np.array(x, np.float32)
28082805

28092806
sx = x.sum()
@@ -4431,7 +4428,7 @@ def hexbin(self, x, y, C=None, gridsize=100, bins=None,
44314428
to the return collection as attributes *hbar* and *vbar*.
44324429
44334430
Notes
4434-
--------
4431+
-----
44354432
The standard descriptions of all the
44364433
:class:`~matplotlib.collections.Collection` parameters:
44374434
@@ -6853,17 +6850,6 @@ def psd(self, x, NFFT=None, Fs=None, Fc=None, detrend=None,
68536850
68546851
%(Line2D)s
68556852
6856-
Notes
6857-
-----
6858-
For plotting, the power is plotted as
6859-
:math:`10\log_{10}(P_{xx})` for decibels, though *Pxx* itself
6860-
is returned.
6861-
6862-
References
6863-
----------
6864-
Bendat & Piersol -- Random Data: Analysis and Measurement Procedures,
6865-
John Wiley & Sons (1986)
6866-
68676853
See Also
68686854
--------
68696855
:func:`specgram`
@@ -6876,6 +6862,17 @@ def psd(self, x, NFFT=None, Fs=None, Fc=None, detrend=None,
68766862
68776863
:func:`csd`
68786864
:func:`csd` plots the spectral density between two signals.
6865+
6866+
Notes
6867+
-----
6868+
For plotting, the power is plotted as
6869+
:math:`10\log_{10}(P_{xx})` for decibels, though *Pxx* itself
6870+
is returned.
6871+
6872+
References
6873+
----------
6874+
Bendat & Piersol -- Random Data: Analysis and Measurement Procedures,
6875+
John Wiley & Sons (1986)
68796876
"""
68806877
if not self._hold:
68816878
self.cla()
@@ -6981,6 +6978,11 @@ def csd(self, x, y, NFFT=None, Fs=None, Fc=None, detrend=None,
69816978
69826979
%(Line2D)s
69836980
6981+
See Also
6982+
--------
6983+
:func:`psd`
6984+
:func:`psd` is the equivalent to setting y=x.
6985+
69846986
Notes
69856987
-----
69866988
For plotting, the power is plotted as
@@ -6991,11 +6993,6 @@ def csd(self, x, y, NFFT=None, Fs=None, Fc=None, detrend=None,
69916993
----------
69926994
Bendat & Piersol -- Random Data: Analysis and Measurement Procedures,
69936995
John Wiley & Sons (1986)
6994-
6995-
See Also
6996-
--------
6997-
:func:`psd`
6998-
:func:`psd` is the equivalent to setting y=x.
69996996
"""
70006997
if not self._hold:
70016998
self.cla()
@@ -7440,11 +7437,6 @@ def specgram(self, x, NFFT=None, Fs=None, Fc=None, detrend=None,
74407437
Additional kwargs are passed on to imshow which makes the
74417438
specgram image
74427439
7443-
Notes
7444-
-----
7445-
*detrend* and *scale_by_freq* only apply when *mode* is set to
7446-
'psd'
7447-
74487440
Returns
74497441
-------
74507442
spectrum : 2-D array
@@ -7478,6 +7470,11 @@ def specgram(self, x, NFFT=None, Fs=None, Fc=None, detrend=None,
74787470
:func:`phase_spectrum`
74797471
A single spectrum, similar to having a single segment when *mode*
74807472
is 'phase'. Plots a line instead of a colormap.
7473+
7474+
Notes
7475+
-----
7476+
The parameters *detrend* and *scale_by_freq* do only apply when *mode*
7477+
is set to 'psd'.
74817478
"""
74827479
if not self._hold:
74837480
self.cla()

0 commit comments

Comments
 (0)