Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Parameter name typo axes -> axis in numpy.fft._pocketfft. #18031

Merged
merged 1 commit into from
Dec 19, 2020

Conversation

Carreau
Copy link
Contributor

@Carreau Carreau commented Dec 19, 2020

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.

numpy/fft/_pocketfft.py Outdated Show resolved Hide resolved
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.
Copy link
Member

@rgommers rgommers left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @Carreau

@rgommers rgommers merged commit 525b789 into numpy:master Dec 19, 2020
@Carreau Carreau deleted the ffttypo branch March 21, 2022 09:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants