8000 DOC: Relocate Line2D args in mlab wrappers. · matplotlib/matplotlib@5546827 · GitHub
[go: up one dir, main page]
Skip to content

Commit 5546827

Browse files
QuLogicQuLogic
committed
DOC: Relocate Line2D args in mlab wrappers.
Stick them under the Parameters heading instead of some other random place (usually References.)
1 parent 7a53ff4 commit 5546827

File tree

1 file changed

+36
-25
lines changed

1 file changed

+36
-25
lines changed

‎lib/matplotlib/axes/_axes.py

Lines changed: 36 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -6565,6 +6565,12 @@ def psd(self, x, NFFT=None, Fs=None, Fc=None, detrend=None,
65656565
Whether to include the line object plotted in the returned values.
65666566
Default is False.
65676567
6568+
**kwargs:
6569+
Keyword arguments control the :class:`~matplotlib.lines.Line2D`
6570+
properties:
6571+
6572+
%(Line2D)s
6573+
65686574
Returns
65696575
-------
65706576
Pxx: 1-D array
@@ -6589,10 +6595,6 @@ def psd(self, x, NFFT=None, Fs=None, Fc=None, detrend=None,
65896595
Bendat & Piersol -- Random Data: Analysis and Measurement Procedures,
65906596
John Wiley & Sons (1986)
65916597
6592-
kwargs control the :class:`~matplotlib.lines.Line2D` properties:
6593-
6594-
%(Line2D)s
6595-
65966598
Examples
65976599
--------
65986600
.. plot:: mpl_examples/pylab_examples/psd_demo.py
@@ -6695,6 +6697,12 @@ def csd(self, x, y, NFFT=None, Fs=None, Fc=None, detrend=None,
66956697
Whether to include the line object plotted in the returned values.
66966698
Default is False.
66976699
6700+
**kwargs:
6701+
Keyword arguments control the :class:`~matplotlib.lines.Line2D`
6702+
properties:
6703+
6704+
%(Line2D)s
6705+
66986706
Returns
66996707
-------
67006708
Pxy: 1-D array
@@ -6719,10 +6727,6 @@ def csd(self, x, y, NFFT=None, Fs=None, Fc=None, detrend=None,
67196727
Bendat & Piersol -- Random Data: Analysis and Measurement Procedures,
67206728
John Wiley & Sons (1986)
67216729
6722-
kwargs control the Line2D properties:
6723-
6724-
%(Line2D)s
6725-
67266730
Examples
67276731
--------
67286732
.. plot:: mpl_examples/pylab_examples/csd_demo.py
@@ -6800,6 +6804,12 @@ def magnitude_spectrum(self, x, Fs=None, Fc=None, window=None,
68006804
when a signal is acquired and then filtered and downsampled to
68016805
baseband.
68026806
6807+
**kwargs:
6808+
Keyword arguments control the :class:`~matplotlib.lines.Line2D`
6809+
properties:
6810+
6811+
%(Line2D)s
6812+
68036813
Returns
68046814
-------
68056815
spectrum: 1-D array
@@ -6811,10 +6821,6 @@ def magnitude_spectrum(self, x, Fs=None, Fc=None, window=None,
68116821
line: a :class:`~matplotlib.lines.Line2D` instance
68126822
The line created by this function
68136823
6814-
kwargs control the :class:`~matplotlib.lines.Line2D` properties:
6815-
6816-
%(Line2D)s
6817-
68186824
Examples
68196825
--------
68206826
.. plot:: mpl_examples/pylab_examples/spectrum_demo.py
@@ -6895,6 +6901,12 @@ def angle_spectrum(self, x, Fs=None, Fc=None, window=None,
68956901
when a signal is acquired and then filtered and downsampled to
68966902
baseband.
68976903
6904+
**kwargs:
6905+
Keyword arguments control the :class:`~matplotlib.lines.Line2D`
6906+
properties:
6907+
6908+
%(Line2D)s
6909+
68986910
Returns
68996911
-------
69006912
spectrum: 1-D array
@@ -6906,10 +6918,6 @@ def angle_spectrum(self, x, Fs=None, Fc=None, window=None,
69066918
line: a :class:`~matplotlib.lines.Line2D` instance
69076919
The line created by this function
69086920
6909-
kwargs control the :class:`~matplotlib.lines.Line2D` properties:
6910-
6911-
%(Line2D)s
6912-
69136921
Examples
69146922
--------
69156923
.. plot:: mpl_examples/pylab_examples/spectrum_demo.py
@@ -6975,6 +6983,12 @@ def phase_spectrum(self, x, Fs=None, Fc=None, window=None,
69756983
when a signal is acquired and then filtered and downsampled to
69766984
baseband.
69776985
6986+
**kwargs:
6987+
Keyword arguments control the :class:`~matplotlib.lines.Line2D`
6988+
properties:
6989+
6990+
%(Line2D)s
6991+
69786992
Returns
69796993
-------
69806994
spectrum: 1-D array
@@ -6986,10 +7000,6 @@ def phase_spectrum(self, x, Fs=None, Fc=None, window=None,
69867000
line: a :class:`~matplotlib.lines.Line2D` instance
69877001
The line created by this function
69887002
6989-
kwargs control the :class:`~matplotlib.lines.Line2D` properties:
6990-
6991-
%(Line2D)s
6992-
69937003
Examples
69947004
--------
69957005
.. plot:: mpl_examples/pylab_examples/spectrum_demo.py
@@ -7054,6 +7064,12 @@ def cohere(self, x, y, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,
70547064
when a signal is acquired and then filtered and downsampled to
70557065
baseband.
70567066
7067+
**kwargs:
7068+
Keyword arguments control the :class:`~matplotlib.lines.Line2D`
7069+
properties of the coherence plot:
7070+
7071+
%(Line2D)s
7072+
70577073
Returns
70587074
-------
70597075
The return value is a tuple (*Cxy*, *f*), where *f* are the
@@ -7066,11 +7082,6 @@ def cohere(self, x, y, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,
70667082
Bendat & Piersol -- Random Data: Analysis and Measurement Procedures,
70677083
John Wiley & Sons (1986)
70687084
7069-
kwargs control the :class:`~matplotlib.lines.Line2D`
7070-
properties of the coherence plot:
7071-
7072-
%(Line2D)s
7073-
70747085
Examples
70757086
--------
70767087
.. plot:: mpl_examples/pylab_examples/cohere_demo.py

0 commit comments

Comments
 (0)
0