Commit 02cd045
authored
[doc-only] cuda.core: add docstrings to Host properties and public StrEnum types (#2134)
* cuda.core: add docstrings to all public StrEnum types in typing.py
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.
* cuda.core: add property docstrings to Host.numa_id and Host.is_numa_current
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().
* cuda.core: fix is_numa_current phrasing and WIN32_KMT description
- is_numa_current: lead with return type (``True`` if ...) to match
bool-property docstring convention; keep :meth:`numa_current` cross-ref
- WIN32_KMT: drop "D3DKMT" (DirectX-specific); CU_MEM_HANDLE_TYPE_WIN32_KMT
maps to a general WDDM kernel-mode handle, not a D3D handle
* docs(typing): fix RST bullet format, accuracy issues, and version notes in StrEnum docstrings
- Convert all enum member descriptions to RST bullet list format
(* ``MEMBER`` -- description) so Sphinx renders them as a list
rather than a run-on paragraph
- Fix VirtualMemoryAllocationType.PINNED: remove incorrect
"page-locked host memory" wording; backing location is
device by default and controlled by VirtualMemoryLocationType
- Fix CompilerBackendType class summary: backend is inferred from
Program.code_type and exposed on Program.backend, not selected
via ProgramOptions
- Move CUDA 13+ version note from ManagedMemoryLocationType.HOST_NUMA
to VirtualMemoryAllocationType.MANAGED (the actual 13+-gated member;
ManagedMemoryResource already requires CUDA 13 so the HOST_NUMA note
was misleading)
- Fix ObjectCodeFormatType summary to mention Linker.link and
Program.as_bytes alongside Program.compile1 parent 6b81b50 commit 02cd045
2 files changed
Lines changed: 88 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
62 | 62 | | |
63 | 63 | | |
64 | 64 | | |
| 65 | + | |
65 | 66 | | |
66 | 67 | | |
67 | 68 | | |
68 | 69 | | |
| 70 | + | |
69 | 71 | | |
70 | 72 | | |
71 | 73 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
43 | 43 | | |
44 | 44 | | |
45 | 45 | | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
46 | 53 | | |
47 | 54 | | |
48 | 55 | | |
49 | 56 | | |
50 | 57 | | |
51 | 58 | | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
52 | 69 | | |
53 | 70 | | |
54 | 71 | | |
| |||
58 | 75 | | |
59 | 76 | | |
60 | 77 | | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
61 | 86 | | |
62 | 87 | | |
63 | 88 | | |
64 | 89 | | |
65 | 90 | | |
66 | 91 | | |
67 | 92 | | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
68 | 100 | | |
69 | 101 | | |
70 | 102 | | |
71 | 103 | | |
72 | 104 | | |
73 | 105 | | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
74 | 113 | | |
75 | 114 | | |
76 | 115 | | |
77 | 116 | | |
78 | 117 | | |
79 | 118 | | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
80 | 126 | | |
81 | 127 | | |
82 | 128 | | |
83 | 129 | | |
84 | 130 | | |
85 | 131 | | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
86 | 139 | | |
87 | 140 | | |
88 | 141 | | |
89 | 142 | | |
90 | 143 | | |
91 | 144 | | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
92 | 152 | | |
93 | 153 | | |
94 | 154 | | |
95 | 155 | | |
96 | 156 | | |
97 | 157 | | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
98 | 166 | | |
99 | 167 | | |
100 | 168 | | |
101 | 169 | | |
102 | 170 | | |
103 | 171 | | |
104 | 172 | | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
105 | 179 | | |
106 | 180 | | |
107 | 181 | | |
108 | 182 | | |
109 | 183 | | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
110 | 190 | | |
111 | 191 | | |
112 | 192 | | |
113 | 193 | | |
114 | 194 | | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
115 | 201 | | |
116 | 202 | | |
117 | 203 | | |
| |||
0 commit comments