8000 DOC: Add space before colon in mlab functions. · matplotlib/matplotlib@337e7f0 · GitHub
[go: up one dir, main page]
Skip to content

Commit 337e7f0

Browse files
QuLogicQuLogic
committed
DOC: Add space before colon in mlab functions.
As noted by @NelleV in another ticket, these don't render correctly.
1 parent e3fb365 commit 337e7f0

File tree

2 files changed

+106
-106
lines changed

2 files changed

+106
-106
lines changed

‎lib/matplotlib/axes/_axes.py

Lines changed: 50 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -6544,43 +6544,43 @@ def psd(self, x, NFFT=None, Fs=None, Fc=None, detrend=None,
65446544
65456545
Parameters
65466546
----------
6547-
x: 1-D array or sequence
6547+
x : 1-D array or sequence
65486548
Array or sequence containing the data
65496549
65506550
%(Spectral)s
65516551
65526552
%(PSD)s
65536553
6554-
noverlap: integer
6554+
noverlap : integer
65556555
The number of points of overlap between segments.
65566556
The default value is 0 (no overlap).
65576557
6558-
Fc: integer
6558+
Fc : integer
65596559
The center frequency of *x* (defaults to 0), which offsets
65606560
the x extents of the plot to reflect the frequency range used
65616561
when a signal is acquired and then filtered and downsampled to
65626562
baseband.
65636563
6564-
return_line: bool
6564+
return_line : bool
65656565
Whether to include the line object plotted in the returned values.
65666566
Default is False.
65676567
6568-
**kwargs:
6568+
**kwargs :
65696569
Keyword arguments control the :class:`~matplotlib.lines.Line2D`
65706570
properties:
65716571
65726572
%(Line2D)s
65736573
65746574
Returns
65756575
-------
6576-
Pxx: 1-D array
6576+
Pxx : 1-D array
65776577
The values for the power spectrum `P_{xx}` before scaling
65786578
(real valued)
65796579
6580-
freqs: 1-D array
6580+
freqs : 1-D array
65816581
The frequencies corresponding to the elements in *Pxx*
65826582
6583-
line: a :class:`~matplotlib.lines.Line2D` instance
6583+
line : a :class:`~matplotlib.lines.Line2D` instance
65846584
The line created by this function.
65856585
Only returned if *return_line* is True.
65866586
@@ -6676,43 +6676,43 @@ def csd(self, x, y, NFFT=None, Fs=None, Fc=None, detrend=None,
66766676
66776677
Parameters
66786678
----------
6679-
x, y: 1-D arrays or sequences
6679+
x, y : 1-D arrays or sequences
66806680
Arrays or sequences containing the data
66816681
66826682
%(Spectral)s
66836683
66846684
%(PSD)s
66856685
6686-
noverlap: integer
6686+
noverlap : integer
66876687
The number of points of overlap between segments.
66886688
The default value is 0 (no overlap).
66896689
6690-
Fc: integer
6690+
Fc : integer
66916691
The center frequency of *x* (defaults to 0), which offsets
66926692
the x extents of the plot to reflect the frequency range used
66936693
when a signal is acquired and then filtered and downsampled to
66946694
baseband.
66956695
6696-
return_line: bool
6696+
return_line : bool
66976697
Whether to include the line object plotted in the returned values.
66986698
Default is False.
66996699
6700-
**kwargs:
6700+
**kwargs :
67016701
Keyword arguments control the :class:`~matplotlib.lines.Line2D`
67026702
properties:
67036703
67046704
%(Line2D)s
67056705
67066706
Returns
67076707
-------
6708-
Pxy: 1-D array
6708+
Pxy : 1-D array
67096709
The values for the cross spectrum `P_{xy}` before scaling
67106710
(complex valued)
67116711
6712-
freqs: 1-D array
6712+
freqs : 1-D array
67136713
The frequencies corresponding to the elements in *Pxy*
67146714
6715-
line: a :class:`~matplotlib.lines.Line2D` instance
6715+
line : a :class:`~matplotlib.lines.Line2D` instance
67166716
The line created by this function.
67176717
Only returned if *return_line* is True.
67186718
@@ -6785,40 +6785,40 @@ def magnitude_spectrum(self, x, Fs=None, Fc=None, window=None,
67856785
67866786
Parameters
67876787
----------
6788-
x: 1-D array or sequence
6788+
x : 1-D array or sequence
67896789
Array or sequence containing the data
67906790
67916791
%(Spectral)s
67926792
67936793
%(Single_Spectrum)s
67946794
6795-
scale: [ 'default' | 'linear' | 'dB' ]
6795+
scale : [ 'default' | 'linear' | 'dB' ]
67966796
The scaling of the values in the *spec*. 'linear' is no scaling.
67976797
'dB' returns the values in dB scale. When *mode* is 'density',
67986798
this is dB power (10 * log10). Otherwise this is dB amplitude
67996799
(20 * log10). 'default' is 'linear'.
68006800
6801-
Fc: integer
6801+
Fc : integer
68026802
The center frequency of *x* (defaults to 0), which offsets
68036803
the x extents of the plot to reflect the frequency range used
68046804
when a signal is acquired and then filtered and downsampled to
68056805
baseband.
68066806
6807-
**kwargs:
6807+
**kwargs :
68086808
Keyword arguments control the :class:`~matplotlib.lines.Line2D`
68096809
properties:
68106810
68116811
%(Line2D)s
68126812
68136813
Returns
68146814
-------
6815-
spectrum: 1-D array
6815+
spectrum : 1-D array
68166816
The values for the magnitude spectrum before scaling (real valued)
68176817
6818-
freqs: 1-D array
6818+
freqs : 1-D array
68196819
The frequencies corresponding to the elements in *spectrum*
68206820
6821-
line: a :class:`~matplotlib.lines.Line2D` instance
6821+
line : a :class:`~matplotlib.lines.Line2D` instance
68226822
The line created by this function
68236823
68246824
Examples
@@ -6888,34 +6888,34 @@ def angle_spectrum(self, x, Fs=None, Fc=None, window=None,
68886888
68896889
Parameters
68906890
----------
6891-
x: 1-D array or sequence
6891+
x : 1-D array or sequence
68926892
Array or sequence containing the data
68936893
68946894
%(Spectral)s
68956895
68966896
%(Single_Spectrum)s
68976897
6898-
Fc: integer
6898+
Fc : integer
68996899
The center frequency of *x* (defaults to 0), which offsets
69006900
the x extents of the plot to reflect the frequency range used
69016901
when a signal is acquired and then filtered and downsampled to
69026902
baseband.
69036903
6904-
**kwargs:
6904+
**kwargs :
69056905
Keyword arguments control the :class:`~matplotlib.lines.Line2D`
69066906
properties:
69076907
69086908
%(Line2D)s
69096909
69106910
Returns
69116911
-------
6912-
spectrum: 1-D array
6912+
spectrum : 1-D array
69136913
The values for the angle spectrum in radians (real valued)
69146914
6915-
freqs: 1-D array
6915+
freqs : 1-D array
69166916
The frequencies corresponding to the elements in *spectrum*
69176917
6918-
line: a :class:`~matplotlib.lines.Line2D` instance
6918+
line : a :class:`~matplotlib.lines.Line2D` instance
69196919
The line created by this function
69206920
69216921
Examples
@@ -6970,34 +6970,34 @@ def phase_spectrum(self, x, Fs=None, Fc=None, window=None,
69706970
69716971
Parameters
69726972
----------
6973-
x: 1-D array or sequence
6973+
x : 1-D array or sequence
69746974
Array or sequence containing the data
69756975
69766976
%(Spectral)s
69776977
69786978
%(Single_Spectrum)s
69796979
6980-
Fc: integer
6980+
Fc : integer
69816981
The center frequency of *x* (defaults to 0), which offsets
69826982
the x extents of the plot to reflect the frequency range used
69836983
when a signal is acquired and then filtered and downsampled to
69846984
baseband.
69856985
6986-
**kwargs:
6986+
**kwargs :
69876987
Keyword arguments control the :class:`~matplotlib.lines.Line2D`
69886988
properties:
69896989
69906990
%(Line2D)s
69916991
69926992
Returns
69936993
-------
6994-
spectrum: 1-D array
6994+
spectrum : 1-D array
69956995
The values for the phase spectrum in radians (real valued)
69966996
6997-
freqs: 1-D array
6997+
freqs : 1-D array
69986998
The frequencies corresponding to the elements in *spectrum*
69996999
7000-
line: a :class:`~matplotlib.lines.Line2D` instance
7000+
line : a :class:`~matplotlib.lines.Line2D` instance
70017001
The line created by this function
70027002
70037003
Examples
@@ -7054,17 +7054,17 @@ def cohere(self, x, y, NFFT=256, Fs=2, Fc=0, detrend=mlab.detrend_none,
70547054
70557055
%(PSD)s
70567056
7057-
noverlap: integer
7057+
noverlap : integer
70587058
The number of points of overlap between blocks. The
70597059
default value is 0 (no overlap).
70607060
7061-
Fc: integer
7061+
Fc : integer
70627062
The center frequency of *x* (defaults to 0), which offsets
70637063
the x extents of the plot to reflect the frequency range used
70647064
when a signal is acquired and then filtered and downsampled to
70657065
baseband.
70667066
7067-
**kwargs:
7067+
**kwargs :
70687068
Keyword arguments control the :class:`~matplotlib.lines.Line2D`
70697069
properties of the coherence plot:
70707070
@@ -7127,48 +7127,48 @@ def specgram(self, x, NFFT=None, Fs=None, Fc=None, detrend=None,
71277127
71287128
Parameters
71297129
----------
7130-
x: 1-D array or sequence
7130+
x : 1-D array or sequence
71317131
Array or sequence containing the data
71327132
71337133
%(Spectral)s
71347134
71357135
%(PSD)s
71367136
7137-
mode: [ 'default' | 'psd' | 'magnitude' | 'angle' | 'phase' ]
7137+
mode : [ 'default' | 'psd' | 'magnitude' | 'angle' | 'phase' ]
71387138
What sort of spectrum to use. Default is 'psd'. which takes
71397139
the power spectral density. 'complex' returns the complex-valued
71407140
frequency spectrum. 'magnitude' returns the magnitude spectrum.
71417141
'angle' returns the phase spectrum without unwrapping. 'phase'
71427142
returns the phase spectrum with unwrapping.
71437143
7144-
noverlap: integer
7144+
noverlap : integer
71457145
The number of points of overlap between blocks. The
71467146
default value is 128.
71477147
7148-
scale: [ 'default' | 'linear' | 'dB' ]
7148+
scale : [ 'default' | 'linear' | 'dB' ]
71497149
The scaling of the values in the *spec*. 'linear' is no scaling.
71507150
'dB' returns the values in dB scale. When *mode* is 'psd',
71517151
this is dB power (10 * log10). Otherwise this is dB amplitude
71527152
(20 * log10). 'default' is 'dB' if *mode* is 'psd' or
71537153
'magnitude' and 'linear' otherwise. This must be 'linear'
71547154
if *mode* is 'angle' or 'phase'.
71557155
7156-
Fc: integer
7156+
Fc : integer
71577157
The center frequency of *x* (defaults to 0), which offsets
71587158
the x extents of the plot to reflect the frequency range used
71597159
when a signal is acquired and then filtered and downsampled to
71607160
baseband.
71617161
7162-
cmap:
7162+
cmap :
71637163
A :class:`matplotlib.colors.Colormap` instance; if *None*, use
71647164
default determined by rc
71657165
7166-
xextent:
7166+
xextent :
71677167
The image extent along the x-axis. xextent = (xmin,xmax)
71687168
The default is (0,max(bins)), where bins is the return
71697169
value from :func:`~matplotlib.mlab.specgram`
71707170
7171-
**kwargs:
7171+
**kwargs :
71727172
Additional kwargs are passed on to imshow which makes the
71737173
specgram image
71747174
@@ -7179,17 +7179,17 @@ def specgram(self, x, NFFT=None, Fs=None, Fc=None, detrend=None,
71797179
71807180
Returns
71817181
-------
7182-
spectrum: 2-D array
7182+
spectrum : 2-D array
71837183
columns are the periodograms of successive segments
71847184
7185-
freqs: 1-D array
7185+
freqs : 1-D array
71867186
The frequencies corresponding to the rows in *spectrum*
71877187
7188-
t: 1-D array
7188+
t : 1-D array
71897189
The times corresponding to midpoints of segments (i.e the columns
71907190
in *spectrum*)
71917191
7192-
im: instance of class :class:`~matplotlib.image.AxesImage`
7192+
im : instance of class :class:`~matplotlib.image.AxesImage`
71937193
The image created by imshow containing the spectrogram
71947194
71957195
Examples

0 commit comments

Comments
 (0)
0