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

sum docstring's description of dtype=None behavior is muddled #623

Closed
oleksandr-pavlyk opened this issue Apr 19, 2023 · 1 comment · Fixed by #666
Closed

sum docstring's description of dtype=None behavior is muddled #623

oleksandr-pavlyk opened this issue Apr 19, 2023 · 1 comment · Fixed by #666
Labels
Narrative Content Narrative documentation content.
Milestone

Comments

@oleksandr-pavlyk
Copy link
Contributor

The first bullet-point of https://data-apis.org/array-api/latest/API_specification/generated/array_api.sum.html describing behavior for dtype=None value stipulates an override condition (if data type of x has wide range than default data-type, use the data type of x), but the subsequence bullet-points unconditionally require output of the default data type for respecting input data type kinds, without acknowledging the exception stated in the first bullet-point.

I wish this description was made clearer. My read is points 2, 3, and 4 hold except in cases stipulated in point 1.

@kgryte
Copy link
Contributor

kgryte commented Apr 19, 2023

@oleksandr-pavlyk Your reading is correct. Agreed that we should be clearer in that regard. Will work on a PR to which clarifies.

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 a pull request may close this issue.

2 participants