cuda.core.system: Document everything, and make it easier to scale#1441
Merged
kkraus14 merged 1 commit intoNVIDIA:mainfrom Jan 9, 2026
Merged
cuda.core.system: Document everything, and make it easier to scale#1441kkraus14 merged 1 commit intoNVIDIA:mainfrom
kkraus14 merged 1 commit intoNVIDIA:mainfrom
Conversation
Contributor
|
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. |
mdboom
force-pushed
the
cuda.core.system-document-all
branch
from
ff0084e to
33fcd0f
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR aims to improve documentation for classes in cuda.core.system._device.pyx and reduce code duplication in the module's __init__.py.
Key changes:
- Enhanced documentation formatting in the
Deviceclass docstring using Sphinx:class:role - Added comprehensive
__all__export list to_device.pyxto properly expose all public classes - Refactored
__init__.pyto usefrom ._device import *pattern, reducing maintenance overhead
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| cuda_core/docs/source/api.rst | Adds documentation entries for system classes (includes non-existent classes) |
| cuda_core/cuda/core/system/_device.pyx | Improves docstring formatting and adds __all__ export list |
| cuda_core/cuda/core/system/init.py | Simplifies imports using wildcard and __all__ extension pattern |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
mdboom
added
enhancement
Contributor
Author
|
/ok to test |
|
kkraus14
approved these changes
Jan 9, 2026
github-actions bot
pushed a commit
that referenced
this pull request
Jan 9, 2026
Removed preview folders for the following PRs: - PR #1441
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
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.
This is just a minor follow-up to #1393 to:
a) Document all the classes in
_device.pyxb) Reduce some duplication in
__init__.py