Skip to content

Commit aee4a4f

Browse files
committed
more doc fixes
1 parent b59918b commit aee4a4f

File tree

7 files changed

+8
-6
lines changed

7 files changed

+8
-6
lines changed

cuda_core/cuda/core/experimental/_event.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,5 +136,5 @@ def is_done(self) -> bool:
136136

137137
@property
138138
def handle(self) -> cuda.bindings.driver.CUevent:
139-
"""Return the underlying cudaEvent_t pointer address as Python int."""
139+
"""Return the underlying CUevent object."""
140140
return self._mnff.handle

cuda_core/cuda/core/experimental/_module.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ def _from_obj(obj, mod):
203203
return ker
204204

205205
@property
206-
def attributes(self):
206+
def attributes(self) -> KernelAttributes:
207207
"""Get the read-only attributes of this kernel."""
208208
if self._attributes is None:
209209
self._attributes = KernelAttributes._init(self._handle)
@@ -294,7 +294,7 @@ def _lazy_load_module(self, *args, **kwargs):
294294
self._handle = handle_return(self._loader["data"](module, 0, [], []))
295295

296296
@precondition(_lazy_load_module)
297-
def get_kernel(self, name):
297+
def get_kernel(self, name) -> Kernel:
298298
"""Return the :obj:`~_module.Kernel` of a specified name from this object code.
299299
300300
Parameters

cuda_core/cuda/core/experimental/_stream.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ def __cuda_stream__(self) -> Tuple[int, int]:
149149

150150
@property
151151
def handle(self) -> cuda.bindings.driver.CUstream:
152-
"""Return the underlying cudaStream_t pointer address as Python int."""
152+
"""Return the underlying ``CUstream`` object."""
153153
return self._mnff.handle
154154

155155
@property

cuda_core/docs/source/_templates/autosummary/class.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
.. rubric:: {{ _('Attributes') }}
2121

2222
{% for item in attributes %}
23-
.. autoattribute:: {{ item }}
23+
.. autoproperty:: {{ item }}
2424
{%- endfor %}
2525
{% endif %}
2626
{% endblock %}

cuda_core/docs/source/api_private.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ CUDA runtime
1717
_stream.Stream
1818
_event.Event
1919
_device.DeviceProperties
20+
_module.KernelAttributes
2021

2122

2223
CUDA compilation toolchain
@@ -26,4 +27,3 @@ CUDA compilation toolchain
2627
:toctree: generated/
2728

2829
_module.Kernel
29-
_module.ObjectCode

cuda_core/docs/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@
9595
intersphinx_mapping = {
9696
"python": ("https://docs.python.org/3/", None),
9797
"numpy": ("https://numpy.org/doc/stable/", None),
98+
"cuda.bindings": ("https://nvidia.github.io/cuda-python/cuda-bindings/latest", None),
9899
}
99100

100101
napoleon_google_docstring = False

cuda_core/tests/example_tests/test_basic_examples.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
import pytest
1515

1616
from cuda.core.experimental import Device
17+
1718
from .utils import run_example
1819

1920
samples_path = os.path.join(os.path.dirname(__file__), "..", "..", "examples")

0 commit comments

Comments
 (0)