Skip to content

cuda.core.system: Document everything, and make it easier to scale - #1441

Merged
kkraus14 merged 1 commit into
NVIDIA:mainfrom
mdboom:cuda.core.system-document-all
Jan 9, 2026
Merged

cuda.core.system: Document everything, and make it easier to scale#1441
kkraus14 merged 1 commit into
NVIDIA:mainfrom
mdboom:cuda.core.system-document-all

Conversation

@mdboom

Copy link
Copy Markdown
Contributor

This is just a minor follow-up to #1393 to:

a) Document all the classes in _device.pyx
b) Reduce some duplication in __init__.py

@mdboom
mdboom requested a review from CopilotJanuary 8, 2026 15:16
@copy-pr-bot

Copy link
Copy Markdown
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
mdboomforce-pushed the cuda.core.system-document-all branch from ff0084e to 33fcd0fCompareJanuary 8, 2026 15:19

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Device class docstring using Sphinx :class: role
  • Added comprehensive __all__ export list to _device.pyx to properly expose all public classes
  • Refactored __init__.py to use from ._device import * pattern, reducing maintenance overhead

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

FileDescription
cuda_core/docs/source/api.rstAdds documentation entries for system classes (includes non-existent classes)
cuda_core/cuda/core/system/_device.pyxImproves docstring formatting and adds __all__ export list
cuda_core/cuda/core/system/init.pySimplifies imports using wildcard and __all__ extension pattern

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment threadcuda_core/docs/source/api.rst
@mdboommdboom added enhancement Any code-related improvements cuda.core Everything related to the cuda.core module labels Jan 8, 2026
@mdboom

Copy link
Copy Markdown
ContributorAuthor

/ok to test

@github-actions

Copy link
Copy Markdown

@mdboommdboom self-assigned this Jan 8, 2026
@kkraus14
kkraus14 merged commit 0c9d301 into NVIDIA:mainJan 9, 2026
82 checks passed
github-actionsBot pushed a commit that referenced this pull request Jan 9, 2026
Removed preview folders for the following PRs:
- PR #1441
@leofangleofang added this to the cuda.core beta 12 milestone Jan 14, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cuda.coreEverything related to the cuda.core moduleenhancementAny code-related improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@mdboom@kkraus14@leofang