diff options
| author | Thomas A Caswell <tcaswell@gmail.com> | 2014-12-09 17:45:06 -0500 |
|---|---|---|
| committer | Thomas A Caswell <tcaswell@bnl.gov> | 2014-12-12 14:00:38 -0500 |
| commit | 994a877d459e4ae9795dc0e35ebb9faef575ad13 (patch) | |
| tree | 59a0e71c1235ea6a70c2d5f5093b66428b616645 /numpy/lib | |
| parent | ad38608c125df357f7136e111f36955b6fab5d33 (diff) | |
| download | numpy-994a877d459e4ae9795dc0e35ebb9faef575ad13.tar.gz | |
DOC : do not abuse enumeration for return types
change '{ndarray, float}' -> 'ndarray or float' as {} are for
when the value is an enumeration
Diffstat (limited to 'numpy/lib')
| -rw-r--r-- | numpy/lib/function_base.py | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/numpy/lib/function_base.py b/numpy/lib/function_base.py index 36ce94bad..7bab66313 100644 --- a/numpy/lib/function_base.py +++ b/numpy/lib/function_base.py @@ -461,7 +461,7 @@ def average(a, axis=None, weights=None, returned=False): Returns ------- - average, [sum_of_weights] : {array_type, double} + average, [sum_of_weights] : array_type or double Return the average along the specified axis. When returned is `True`, return a tuple with the average as the first element and the sum of the weights as the second element. The return type is `Float` @@ -1147,7 +1147,7 @@ def interp(x, xp, fp, left=None, right=None, period=None): Returns ------- - y : {float, ndarray} + y : float or ndarray The interpolated values, same shape as `x`. Raises @@ -1250,7 +1250,7 @@ def angle(z, deg=0): Returns ------- - angle : {ndarray, scalar} + angle : ndarray or scalar The counterclockwise angle from the positive real axis on the complex plane, with dtype as numpy.float64. @@ -1980,7 +1980,7 @@ def corrcoef(x, y=None, rowvar=1, bias=0, ddof=None): observations (unbiased estimate). If `bias` is 1, then normalization is by ``N``. These values can be overridden by using the keyword ``ddof`` in numpy versions >= 1.5. - ddof : {None, int}, optional + ddof : 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 |