Skip to content

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

Merged
merged 5 commits into from
Feb 14, 2024
Merged

Nit: clarify s & axes in FFT docs #746

merged 5 commits into from
Feb 14, 2024

Conversation

leofang
Copy link
Contributor

@leofang leofang commented Feb 12, 2024

@asmeurer
Copy link
Member

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".

@leofang
Copy link
Contributor Author

leofang commented Feb 12, 2024

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.

@asmeurer
Copy link
Member

The other functions with axes (as opposed to axis) are

  • permute_dims: this doesn't allow negative axes, and already says it should be "a permutation" which implies no duplicates
  • tensordot: Doesn't say anything. Do duplicate axes make sense in this function?

@kgryte
Copy link
Contributor

kgryte commented Feb 13, 2024

Thanks, @leofang! If the suggestions are good for you, this should be ready for merge after resolution.

@leofang
Copy link
Contributor Author

leofang commented Feb 13, 2024

Thanks, @kgryte, suggestions applied.

Copy link
Contributor

@kgryte kgryte 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, @leofang!

@kgryte kgryte merged commit 474ec2b into data-apis:main Feb 14, 2024
@leofang leofang deleted the fft_nits branch February 14, 2024 15:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Narrative Content Narrative documentation content.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

RFC: Explicit forbid any axes being repeated in the axes of the multi-dimensional FFT APIs?
3 participants