Skip to content

API specification seems to assume all arrays are floats #83

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

Closed
eric-wieser opened this issue Nov 11, 2020 · 3 comments
Closed

API specification seems to assume all arrays are floats #83

eric-wieser opened this issue Nov 11, 2020 · 3 comments
Labels
Narrative Content Narrative documentation content.

Comments

@eric-wieser
Copy link

The description of __abs__ and especially __add__ seems to try to go into great detail about how floating point addition / abs works.

I'd argue this obscures the intent behind what is ultimately a container API, and it would be better to refer to the IEEE 754 spec (or perhaps add a separate page summarizing IEEE 754)

@rgommers
Copy link
Member

That does sound like a good idea to make things easier on the reader. A separate page summarizing IEEE 754 sounds good to me, because that standard is non-free as well as painful to read.

@kgryte kgryte added the stale label Oct 4, 2021
@kgryte
Copy link
Contributor

kgryte commented Oct 4, 2021

Rather than add a separate page, an alternative could be to place IEEE 754 details, or special cases in general, within a collapsible HTML section (aka, a details element).

@kgryte kgryte removed the stale label Oct 4, 2021
@rgommers rgommers added the Narrative Content Narrative documentation content. label Sep 5, 2022
@kgryte
Copy link
Contributor

kgryte commented Jun 29, 2023

As part of #533, we'll move special cases below the fold, which should help address this issue. As such, I'll go ahead and close.

@kgryte kgryte closed this as completed Jun 29, 2023
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

No branches or pull requests

3 participants