cuda.core: add docstrings to Host properties and public StrEnum types#2134
Open
aryanputta wants to merge 2 commits into
Open
cuda.core: add docstrings to Host properties and public StrEnum types#2134aryanputta wants to merge 2 commits into
aryanputta wants to merge 2 commits into
Conversation
Each StrEnum class in cuda.core.typing now has a class-level docstring that states its purpose and briefly describes every member value. Sphinx and help() now show meaningful descriptions for CompilerBackendType, GraphConditionalType, GraphMemoryType, ManagedMemoryLocationType, ObjectCodeFormatType, PCHStatusType, SourceCodeType, VirtualMemory*. No logic changes.
…urrent Host is a new 1.1.0 API. The class-level docstring is complete but the two public properties had no docstrings, leaving them blank in generated API docs and in help().
Contributor
Contributor
Author
|
@leofang @rwgk — flagging this for your awareness in the context of #2131. This is a doc-only contribution to
Happy to split into two PRs if that's easier to review, or adjust wording on any of the docstrings. |
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.
Summary
Contributes to the doc-finalization step of #2131.
Two doc-only changes to
cuda.core, touching no logic:cuda/core/_host.py— Host property docstringsHostis a new 1.1.0 API (release notes: #2131 checklist item "Finalize the doc update"). The class-level docstring is already complete, butnuma_idandis_numa_currenthad no docstrings, leaving them blank in generated API docs andhelp():cuda/core/typing.py— StrEnum class docstringsAll 11 public
StrEnumsubclasses (SourceCodeType,ObjectCodeFormatType,CompilerBackendType,PCHStatusType,GraphConditionalType,GraphMemoryType,ManagedMemoryLocationType,VirtualMemoryHandleType,VirtualMemoryLocationType,VirtualMemoryGranularityType,VirtualMemoryAccessType,VirtualMemoryAllocationType) previously had zero class-level docstrings. Each now has a short description and a one-liner per member sohelp()and Sphinx show meaningful output.Checklist
cuda.coreonly — nocuda.bindingsfiles touchedHost.numa_current,ManagedBuffermethods)