diff options
| author | Antony Lee <anntzer.lee@gmail.com> | 2020-12-29 18:53:53 +0100 |
|---|---|---|
| committer | Antony Lee <anntzer.lee@gmail.com> | 2020-12-29 21:18:08 +0100 |
| commit | f36e940a4726abb38c4929259e8eaf00d68c3d18 (patch) | |
| tree | 3f36ded5bc3921b181e6bcdf7dc9b1c08ac2e50b /numpy/lib/function_base.py | |
| parent | 717df4e93234a1a290aa1b472b5c1c4e600009cd (diff) | |
| download | numpy-f36e940a4726abb38c4929259e8eaf00d68c3d18.tar.gz | |
DOC: Avoid using "set of" when talking about an ordered list.
... or when the input isn't/cannot be a set. I left a few usages, e.g.
in random sampling, where "set" is reasonable as informal description of
an array as the order doesn't matter; however, for e.g. np.gradient the
order of the returned list is clearly important, so "set" is wrong.
Also some other minor doc edits noticed during the grepping: using
`shape` instead of `form` in `cov` is consistent with most other places;
the wording in `Polynomial.trim` now matches other methods on the same
class.
Diffstat (limited to 'numpy/lib/function_base.py')
| -rw-r--r-- | numpy/lib/function_base.py | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/numpy/lib/function_base.py b/numpy/lib/function_base.py index 696fe617b..276ffa5d4 100644 --- a/numpy/lib/function_base.py +++ b/numpy/lib/function_base.py @@ -846,7 +846,7 @@ def gradient(f, *varargs, axis=None, edge_order=1): Returns ------- gradient : ndarray or list of ndarray - A set of ndarrays (or a single ndarray if there is only one dimension) + A list of ndarrays (or a single ndarray if there is only one dimension) corresponding to the derivatives of f with respect to each dimension. Each derivative has the same shape as f. |