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

Skip to content

Commit 3cac065

Browse files
committed
Fix doc build
1 parent eb72fe6 commit 3cac065

File tree

1 file changed

+23
-25
lines changed

1 file changed

+23
-25
lines changed

lib/matplotlib/axes/_axes.py

Lines changed: 23 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1737,40 +1737,41 @@ def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none,
17371737
17381738
y : sequence of scalars of length n
17391739
1740-
hold : boolean, optional, *deprecated*, default: True
1740+
hold : bool, optional, *deprecated*, default: True
17411741
17421742
detrend : callable, optional, default: `mlab.detrend_none`
17431743
*x* is detrended by the *detrend* callable. Default is no
17441744
normalization.
17451745
1746-
normed : boolean, optional, default: True
1746+
normed : bool, optional, default: True
17471747
If ``True``, input vectors are normalised to unit length.
17481748
1749-
usevlines : boolean, optional, default: True
1749+
usevlines : bool, optional, default: True
17501750
If ``True``, `Axes.vlines` is used to plot the vertical lines from
17511751
the origin to the acorr. Otherwise, `Axes.plot` is used.
17521752
1753-
maxlags : integer, optional, default: 10
1753+
maxlags : int, optional
17541754
Number of lags to show. If None, will return all ``2 * len(x) - 1``
1755-
lags.
1755+
lags. Default is 10.
17561756
17571757
Returns
17581758
-------
17591759
tuple
17601760
(lags, c, line, b) : where:
17611761
17621762
- *lags* are a length ``2*maxlags+1`` lag vector.
1763-
- *c* is the length ``2*maxlags+1` auto correlation vector.
1763+
- *c* is the length ``2*maxlags+1`` auto correlation vector.
17641764
- *line* is a `~matplotlib.lines.Line2D` instance returned by
17651765
`plot`.
17661766
- *b* is the x-axis (none, if plot is used).
17671767
17681768
Other Parameters
17691769
----------------
1770-
linestyle : `~matplotlib.lines.Line2D` prop, optional, default: None
1770+
linestyle : `~matplotlib.lines.Line2D` property, optional
17711771
Only used if usevlines is ``False``.
17721772
1773-
marker : string, optional, default: 'o'
1773+
marker : string, optional
1774+
Default is 'o'.
17741775
17751776
Notes
17761777
-----
@@ -5584,7 +5585,7 @@ def pcolormesh(self, *args, **kwargs):
55845585
scale luminance data to 0,1. If ``None``, defaults to
55855586
:func:`normalize`.
55865587
5587-
vmin, vmax: scalar, optional
5588+
vmin, vmax : scalar, optional
55885589
*vmin* and *vmax* are used in conjunction with *norm* to
55895590
normalize luminance data. If either is ``None``, it is autoscaled
55905591
to the respective min or max of the color array *C*.
@@ -5596,36 +5597,33 @@ def pcolormesh(self, *args, **kwargs):
55965597
'gouraud', each quad will be Gouraud shaded. When gouraud
55975598
shading, *edgecolors* is ignored.
55985599
5599-
edgecolors : [*None* | ``'None'`` | ``'face'`` | color |
5600-
color sequence], optional
5601-
If ``None``, the rc setting is used by default.
5602-
5603-
If ``'None'``, edges will not be visible.
5600+
edgecolors : string, color, color sequence, optional
5601+
- If ``None``, the rc setting is used by default.
5602+
- If ``'None'``, edges will not be visible.
5603+
- If ``'face'``, edges will have the same color as the faces.
56045604
5605-
If ``'face'``, edges will have the same color as the faces.
5606-
5607-
An mpl color or sequence of colors will set the edge color
5605+
An mpl color or sequence of colors will also set the edge color.
56085606
56095607
alpha : scalar, optional
56105608
Alpha blending value. Must be between 0 and 1.
56115609
56125610
Returns
56135611
-------
5614-
:class:`matplotlib.collections.QuadMesh`
5612+
matplotlib.collections.QuadMesh
5613+
5614+
See Also
5615+
--------
5616+
matplotlib.pyplot.pcolor :
5617+
For an explanation of the grid orientation
5618+
(:ref:`Grid Orientation <axes-pcolor-grid-orientation>`)
5619+
and the expansion of 1-D *X* and/or *Y* to 2-D arrays.
56155620
56165621
Notes
56175622
-----
56185623
kwargs can be used to control the
56195624
:class:`matplotlib.collections.QuadMesh` properties:
56205625
56215626
%(QuadMesh)s
5622-
5623-
See also
5624-
--------
5625-
:func:`~matplotlib.pyplot.pcolor` :
5626-
For an explanation of the grid orientation
5627-
(:ref:`Grid Orientation <axes-pcolor-grid-orientation>`)
5628-
and the expansion of 1-D *X* and/or *Y* to 2-D arrays.
56295627
"""
56305628
if not self._hold:
56315629
self.cla()

0 commit comments

Comments
 (0)