-
Notifications
You must be signed in to change notification settings - Fork 52
Nit: clarify s
& axes
in FFT docs
#746
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
Conversation
Does this text match what is used elsewhere? I would word it more like "if axes contains multiple entries referring to the same dimension..." or something like that, since a positive and negative axis can refer to the same dimension but not actually be a "repeated entry". |
That's a good point. No, as I noted in #747 I think this is the very first time that we've ever cared about (effectively) repeating axes in the standard. I'll update. |
The other functions with
|
Thanks, @leofang! If the suggestions are good for you, this should be ready for merge after resolution. |
Co-authored-by: Athan <[email protected]>
Thanks, @kgryte, suggestions applied. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks, @leofang!
i
meaning in the docstrings involvings
axes
axes
has repeated entries, the behavior is undefined (close RFC: Explicit forbid any axes being repeated in theaxes
of the multi-dimensional FFT APIs? #747)