diff options
| author | Matthias Bussonnier <bussonniermatthias@gmail.com> | 2020-12-18 17:34:41 -0800 |
|---|---|---|
| committer | Matthias Bussonnier <bussonniermatthias@gmail.com> | 2020-12-18 19:56:37 -0800 |
| commit | 7dce0ed00dd406d03705257514e6fac9fa4e25bb (patch) | |
| tree | fb7f2037e90434a01ce1c932b5ef6dab4f5c8e18 /numpy | |
| parent | bac54ecb0b815eea2e8116d21aa96e1387793468 (diff) | |
| download | numpy-7dce0ed00dd406d03705257514e6fac9fa4e25bb.tar.gz | |
DOC: Parameter name typo axes -> axis in numpy.fft._pocketfft.
The parameter name seem to have a typo in both those case and reference
axis (and not axes), this is likely due to copy-past as some other
functions in this modules use axes (when several indices are required),
but other also use `axis` and have the correct spelling.
From review it also seem like previous phrasing is unclear so update
all similar entries to reflect the new phrasing.
Diffstat (limited to 'numpy')
| -rw-r--r-- | numpy/fft/_pocketfft.py | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/numpy/fft/_pocketfft.py b/numpy/fft/_pocketfft.py index 2066b95ea..bf0e60b6d 100644 --- a/numpy/fft/_pocketfft.py +++ b/numpy/fft/_pocketfft.py @@ -160,7 +160,7 @@ def fft(a, n=None, axis=-1, norm=None): Raises ------ IndexError - if `axes` is larger than the last axis of `a`. + If `axis` is not a valid axis of `a`. See Also -------- @@ -272,7 +272,7 @@ def ifft(a, n=None, axis=-1, norm=None): Raises ------ IndexError - If `axes` is larger than the last axis of `a`. + If `axis` is not a valid axis of `a`. See Also -------- @@ -358,7 +358,7 @@ def rfft(a, n=None, axis=-1, norm=None): Raises ------ IndexError - If `axis` is larger than the last axis of `a`. + If `axis` is not a valid axis of `a`. See Also -------- @@ -461,7 +461,7 @@ def irfft(a, n=None, axis=-1, norm=None): Raises ------ IndexError - If `axis` is larger than the last axis of `a`. + If `axis` is not a valid axis of `a`. See Also -------- @@ -556,7 +556,7 @@ def hfft(a, n=None, axis=-1, norm=None): Raises ------ IndexError - If `axis` is larger than the last axis of `a`. + If `axis` is not a valid axis of `a`. See also -------- |