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

refactor Linker and Program Options documentation for attribute level information #431

Open
ksimpson-work opened this issue Feb 3, 2025 · 0 comments
Open

refactor Linker and Program Options documentation for attribute level information #431

ksimpson-work opened this issue Feb 3, 2025 · 0 comments
Assignees
@ksimpson-work
Labels
cuda.core Everything related to the cuda.core module documentation Improvements or additions to documentation P1 Medium priority - Should do triage Needs the team's attention

Comments

@ksimpson-work
Copy link
Contributor

ksimpson-work commented Feb 3, 2025 •
edited
Loading

the docstrings for both classes document the members of the dataclass at the top level. ie the docstring for the class is complete and provides a complete description in the built docs html, however the individual attributes do not support mouse hover descriptions.

Move the docstrings from the top level to the individual attributes.

depends on #435 for a cleaner diff
@ksimpson-work ksimpson-work added cuda.core Everything related to the cuda.core module documentation Improvements or additions to documentation P1 Medium priority - Should do triage Needs the team's attention labels Feb 3, 2025
@ksimpson-work ksimpson-work mentioned this issue Feb 3, 2025
Merged
@ksimpson-work ksimpson-work self-assigned this Feb 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ksimpson-work ksimpson-work

Labels
cuda.core Everything related to the cuda.core module documentation Improvements or additions to documentation P1 Medium priority - Should do triage Needs the team's attention
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ksimpson-work