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/lib/function_base.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/lib/function_base.py')
| -rw-r--r-- | numpy/lib/function_base.py | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/numpy/lib/function_base.py b/numpy/lib/function_base.py index d4db4dab1..38a96707f 100644 --- a/numpy/lib/function_base.py +++ b/numpy/lib/function_base.py @@ -1146,11 +1146,12 @@ def interp(x, xp, fp, left=None, right=None, period=None): Value to return for `x > xp[-1]`, default is `fp[-1]`. period : None or float, optional - .. versionadded:: 1.10.0 A period for the x-coordinates. This parameter allows the proper interpolation of angular x-coordinates. Parameters `left` and `right` are ignored if `period` is specified. + .. versionadded:: 1.10.0 + Returns ------- y : float or ndarray @@ -1863,23 +1864,26 @@ def cov(m, y=None, rowvar=1, bias=0, ddof=None, fweights=None, aweights=None): normalization is by ``N``. These values can be overridden by using the keyword ``ddof`` in numpy versions >= 1.5. ddof : int, optional - .. versionadded:: 1.5 If not ``None`` the default value implied by `bias` is overridden. Note that ``ddof=1`` will return the unbiased estimate, even if both `fweights` and `aweights` are specified, and ``ddof=0`` will return the simple average. See the notes for the details. The default value is ``None``. + + .. versionadded:: 1.5 fweights : array_like, int, optional - .. versionadded:: 1.10 1-D array of integer freguency weights; the number of times each observation vector should be repeated. - aweights : array_like, optional + .. versionadded:: 1.10 + aweights : array_like, optional 1-D array of observation vector weights. These relative weights are typically large for observations considered "important" and smaller for observations considered less "important". If ``ddof=0`` the array of weights can be used to assign probabilities to observation vectors. + .. versionadded:: 1.10 + Returns ------- out : ndarray @@ -2054,12 +2058,14 @@ def corrcoef(x, y=None, rowvar=1, bias=np._NoValue, ddof=np._NoValue): 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. - ddof : _NoValue, optional + .. deprecated:: 1.10.0 + ddof : _NoValue, optional Has no affect, do not use. + .. deprecated:: 1.10.0 + Returns ------- R : ndarray |