diff options
| author | Charles Harris <charlesr.harris@gmail.com> | 2015-07-01 23:36:38 -0600 |
|---|---|---|
| committer | Charles Harris <charlesr.harris@gmail.com> | 2015-07-01 23:40:56 -0600 |
| commit | f5e9adbbf87903e42d03bb3dd5f86b70a89e930c (patch) | |
| tree | d35f5116d0ce8c579b583cda4a3ee32c541fb6bd /numpy/ma/extras.py | |
| parent | f940a9e434e2ba39328361336711502895a42194 (diff) | |
| download | numpy-f5e9adbbf87903e42d03bb3dd5f86b70a89e930c.tar.gz | |
DOC: Fix docstring warnings in documetation generation.
Most of these fixes involve putting blank lines around
.. versionadded:: x.x.x
and
.. deprecated:: x.x.x
Some of the examples were also fixed.
Diffstat (limited to 'numpy/ma/extras.py')
| -rw-r--r-- | numpy/ma/extras.py | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/numpy/ma/extras.py b/numpy/ma/extras.py index 2f8114563..bd593e65f 100644 --- a/numpy/ma/extras.py +++ b/numpy/ma/extras.py @@ -1371,11 +1371,11 @@ def cov(x, y=None, rowvar=True, bias=False, allow_masked=True, ddof=None): in `x`, the corresponding value is masked in `y`. If False, raises a `ValueError` exception when some values are missing. ddof : {None, int}, optional - .. versionadded:: 1.5 If not ``None`` normalization is by ``(N - ddof)``, where ``N`` is the number of observations; this overrides the value implied by ``bias``. The default value is ``None``. + .. versionadded:: 1.5 Raises ------ @@ -1430,17 +1430,19 @@ def corrcoef(x, y=None, rowvar=True, bias=np._NoValue, allow_masked=True, is transposed: each column represents a variable, while the rows contain observations. bias : _NoValue, optional - .. deprecated:: 1.10.0 Has no affect, do not use. + + .. deprecated:: 1.10.0 allow_masked : bool, optional If True, masked values are propagated pair-wise: if a value is masked in `x`, the corresponding value is masked in `y`. If False, raises an exception. Because `bias` is deprecated, this argument needs to be treated as keyword only to avoid a warning. ddof : _NoValue, optional - .. deprecated:: 1.10.0 Has no affect, do not use. + .. deprecated:: 1.10.0 + See Also -------- numpy.corrcoef : Equivalent function in top-level NumPy module. |