DOC: Add admonition to docstrings for cuda.core handle properties #573
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Auto-sync is disabled for ready for review pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
carterbox
force-pushed
the
dching/note-CUObject-c-pointer
branch
from
3ccaf67 to
70ff96b
Compare
|
/ok to test 70ff96b |
leofang
added
documentation
This comment has been minimized.
This comment has been minimized.
|
Sorry for delay @carterbox. Would you mind making the following changes:
|
|
/ok to test 8d87136 |
leofang
requested changes
Apr 25, 2025
carterbox
force-pushed
the
dching/note-CUObject-c-pointer
branch
from
8d87136 to
db2d0b4
Compare
|
/ok to test db2d0b4 |
leofang
approved these changes
Apr 26, 2025
|
Thank you, Daniel! |
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds caution admonition to documentation for users who are accessing the handle property of cuda.core objects. The alternative was to add a docstring for int() for the cuda.bindings python objects. However, these python objects are autogenerated, and I couldn't see where the bindings were generated from. There's just text at the top of all the pyx files that state the bindings are autogenerated and that they should not be manually edited.
closes #557
Checklist