Equip python functions, classes, methods and exceptions with docstrings #294
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
oleksandr-pavlyk
changed the title
oleksandr-pavlyk
force-pushed
the
add-docstrings
branch
from
0c6b97e to
6a8bac5
Compare
Collaborator
Author
oleksandr-pavlyk
force-pushed
the
add-docstrings
branch
from
6a8bac5 to
786645f
Compare
Collaborator
Author
|
@shwina @NaderAlAwar I resolved merge conflicts introduced recently in wheel publishing PR. Please take a look to make sure I did not inadvertently introduce a bug. Thanks! |
Collaborator
|
The conflict seems to have been in |
oleksandr-pavlyk
force-pushed
the
add-docstrings
branch
from
786645f to
9f709c9
Compare
Added tests that docstrings exist and are not empty. This closes NVIDIA#291
Use py::gil_safe_call_once_and_store facility pybind11 provides.
oleksandr-pavlyk
force-pushed
the
add-docstrings
branch
from
9f709c9 to
8ff0557
Compare
NaderAlAwar
approved these changes
Feb 3, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR builds on top of #290. Hence, it should be merged after #290 has been merged.
This PR moves doc-strings for Python objects exposed in
cuda.benchnamespace from__init__.pyito implementation file, making doc-strings interactively available to the user. For example,help(cuda.bench.State)would not include doc-strings of the class itself as well as of its methods.Closes #291