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: Disclaimer for FFT library #17028

Merged
merged 1 commit into from Aug 9, 2020
Merged

Conversation

bjnath
Copy link
Contributor

@bjnath bjnath commented Aug 7, 2020

Adds sentence to the top of routines.fft.html explaining that scipy.fft
is a more comprehensive collection, per mailing list discussion
(http://numpy-discussion.10968.n7.nabble.com/Add-Chebyshev-cosine-transforms-implemented-via-FFTs-td48373.html#a48382)

@grlee77
Copy link
Contributor

grlee77 commented Aug 8, 2020

Looks good. Aside from the extended set of functions provided, scipy.fft also supports single-precision and multithreading, but I don't know that we need to get into that level of comparison here.

@bjnath
Copy link
Contributor Author

bjnath commented Aug 8, 2020

@grlee77 That's a good point; "superset" while technically true doesn't really convey scipy's bigger scope.

Reworded it to call scipy "more comprehensive".

Hopefully the reader can take a hint.

Adds sentence to the top of routines.fft.html explaining that scipy.fft
is a more comprehensive collection, per mailing list discussion
(http://numpy-discussion.10968.n7.nabble.com/Add-Chebyshev-cosine-transforms-implemented-via-FFTs-td48373.html#a48382)
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.

Make a tiny tweak, adding an intersphinx link and changing "library" to "module". In it goes. Thanks @bjnath

@rgommers rgommers merged commit dbf3744 into numpy:master Aug 9, 2020
@bjnath
Copy link
Contributor Author

bjnath commented Aug 9, 2020

+1 for both. Great idea to add a link.

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