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.

Sign up for GitHub

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

Jump to bottom

Bug: descriptions for constants included in the standard are incorrect #601

Closed
kgryte opened this issue Feb 19, 2023 · 4 comments · Fixed by #659
Closed

Bug: descriptions for constants included in the standard are incorrect #601

kgryte opened this issue Feb 19, 2023 · 4 comments · Fixed by #659
Labels
bug Something isn't working.
Milestone
v2023

Comments

@kgryte
Copy link
Contributor

kgryte commented Feb 19, 2023

See screenshot below:

image

This affects all currently rendered specification versions.
@kgryte kgryte added the bug Something isn't working. label Feb 19, 2023
@honno
Copy link
Member

honno commented Feb 19, 2023

I'll have a look next week if no one else does, I think I at one point encountered and fixed this, then regressed that somehow 😅

@rgommers
Copy link
Member

I had a quick look. The descriptions are in strings in .py files below the actual constants. autosummary doesn't work like that AFAIK, I think these descriptions belong in the .rst files instead. Or am I missing anything here?

@kgryte kgryte added this to the v2023 milestone Jun 29, 2023
@kgryte
Copy link
Contributor Author

kgryte commented Jun 29, 2023

@honno were you able to address this?

@honno
Copy link
Member

honno commented Jun 29, 2023

were you able to address this?

Nope, did play around a bit a few weeks back but nothing worked, need to find some time to sit down and try again.

@kgryte kgryte mentioned this issue Jun 29, 2023
Closed
17 tasks
asmeurer added a commit to asmeurer/array-api that referenced this issue Jul 15, 2023
@asmeurer
Fix documentation for constants
6a2dea2 
Sphinx cannot find the docstring corresponding to a constant unless you point
it to the exact file where it is, since it doesn't actually live on the object
itself. See sphinx-doc/sphinx#6495

Fixes data-apis#601
@asmeurer asmeurer mentioned this issue Jul 15, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working.
Projects
None yet
Milestone
v2023
Development

Successfully merging a pull request may close this issue.

Fix documentation for constants asmeurer/array-api
3 participants
@rgommers @kgryte @honno