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 /tools/refguide_check.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 'tools/refguide_check.py')
| -rw-r--r-- | tools/refguide_check.py | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/tools/refguide_check.py b/tools/refguide_check.py index f0f6461b7..ddcc1028d 100644 --- a/tools/refguide_check.py +++ b/tools/refguide_check.py @@ -305,7 +305,7 @@ def compare(all_dict, others, names, module_name): List of non deprecated sub modules for module_name others : list List of sub modules for module_name - names : set + names : set Set of function names or special directives present in docstring of module_name module_name : ModuleType @@ -780,7 +780,7 @@ def _run_doctests(tests, full_name, verbose, doctest_warnings): Parameters ---------- - tests: list + tests : list full_name : str |