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

Stop repeating input/output type info in docstrings #454

Open
leofang opened this issue Feb 18, 2025 · 1 comment
Open

Stop repeating input/output type info in docstrings #454

leofang opened this issue Feb 18, 2025 · 1 comment
Labels
cuda.core Everything related to the cuda.core module documentation Improvements or additions to documentation P1 Medium priority - Should do
Milestone
cuda.core beta 4

Comments

@leofang
Copy link
Member

leofang commented Feb 18, 2025 •
edited
Loading

I think Sphinx is able to figure out the types and keep them in the document by inspecting the typing info, which going forward should be our source of truth (#312 (comment)). We should not repeat ourselves.
@leofang leofang added cuda.core Everything related to the cuda.core module documentation Improvements or additions to documentation P1 Medium priority - Should do labels Feb 18, 2025
@leofang leofang added this to the cuda.core beta 4 milestone Feb 18, 2025
@leofang
Copy link
Member Author

leofang commented Feb 24, 2025

I noticed there are some issues for Sphinx to handle type alias properly. We need to proceed with caution.

sphinx-doc/sphinx#11991

@leofang leofang mentioned this issue Feb 24, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
cuda.core Everything related to the cuda.core module documentation Improvements or additions to documentation P1 Medium priority - Should do
Projects
None yet
Milestone
cuda.core beta 4
Development

No branches or pull requests
1 participant
@leofang