@@ -1737,40 +1737,41 @@ def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none,
1737
1737
1738
1738
y : sequence of scalars of length n
1739
1739
1740
- hold : boolean , optional, *deprecated*, default: True
1740
+ hold : bool , optional, *deprecated*, default: True
1741
1741
1742
1742
detrend : callable, optional, default: `mlab.detrend_none`
1743
1743
*x* is detrended by the *detrend* callable. Default is no
1744
1744
normalization.
1745
1745
1746
- normed : boolean , optional, default: True
1746
+ normed : bool , optional, default: True
1747
1747
If ``True``, input vectors are normalised to unit length.
1748
1748
1749
- usevlines : boolean , optional, default: True
1749
+ usevlines : bool , optional, default: True
1750
1750
If ``True``, `Axes.vlines` is used to plot the vertical lines from
1751
1751
the origin to the acorr. Otherwise, `Axes.plot` is used.
1752
1752
1753
- maxlags : integer , optional, default: 10
1753
+ maxlags : int , optional
1754
1754
Number of lags to show. If None, will return all ``2 * len(x) - 1``
1755
- lags.
1755
+ lags. Default is 10.
1756
1756
1757
1757
Returns
1758
1758
-------
1759
1759
tuple
1760
1760
(lags, c, line, b) : where:
1761
1761
1762
1762
- *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.
1764
1764
- *line* is a `~matplotlib.lines.Line2D` instance returned by
1765
1765
`plot`.
1766
1766
- *b* is the x-axis (none, if plot is used).
1767
1767
1768
1768
Other Parameters
1769
1769
----------------
1770
- linestyle : `~matplotlib.lines.Line2D` prop , optional, default: None
1770
+ linestyle : `~matplotlib.lines.Line2D` property , optional
1771
1771
Only used if usevlines is ``False``.
1772
1772
1773
- marker : string, optional, default: 'o'
1773
+ marker : string, optional
1774
+ Default is 'o'.
1774
1775
1775
1776
Notes
1776
1777
-----
@@ -5584,7 +5585,7 @@ def pcolormesh(self, *args, **kwargs):
5584
5585
scale luminance data to 0,1. If ``None``, defaults to
5585
5586
:func:`normalize`.
5586
5587
5587
- vmin, vmax: scalar, optional
5588
+ vmin, vmax : scalar, optional
5588
5589
*vmin* and *vmax* are used in conjunction with *norm* to
5589
5590
normalize luminance data. If either is ``None``, it is autoscaled
5590
5591
to the respective min or max of the color array *C*.
@@ -5596,36 +5597,33 @@ def pcolormesh(self, *args, **kwargs):
5596
5597
'gouraud', each quad will be Gouraud shaded. When gouraud
5597
5598
shading, *edgecolors* is ignored.
5598
5599
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.
5604
5604
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.
5608
5606
5609
5607
alpha : scalar, optional
5610
5608
Alpha blending value. Must be between 0 and 1.
5611
5609
5612
5610
Returns
5613
5611
-------
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.
5615
5620
5616
5621
Notes
5617
5622
-----
5618
5623
kwargs can be used to control the
5619
5624
:class:`matplotlib.collections.QuadMesh` properties:
5620
5625
5621
5626
%(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.
5629
5627
"""
5630
5628
if not self ._hold :
5631
5629
self .cla ()
0 commit comments