Nit: clarify `s` & `axes` in FFT docs

data-apis / array-api

RFC document, tooling and other content related to the array API standard

https://data-apis.github.io/array-api/latest/

MIT License

205 stars 42 forks source link

Nit: clarify `s` & `axes` in FFT docs #746

Closed leofang closed 4 months ago

leofang commented 4 months ago

Clarify the axis i meaning in the docstrings involving s
Clarify that the description is mainly for individual axis in the docstrings involving axes
Clarify that if axes has repeated entries, the behavior is undefined (close #747)

asmeurer commented 4 months ago

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 commented 4 months ago

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 commented 4 months ago

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 commented 4 months ago

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

leofang commented 4 months ago

Thanks, @kgryte, suggestions applied.