Skip to content

Commit 12f45ac

Browse files
committed
Fix doc/annotation of enqueue_map_image return value
Closes gh-872
1 parent 39e41dc commit 12f45ac

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

doc/runtime_memory.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -418,8 +418,8 @@ Mapping Memory into Host Address Space
418418
See :class:`map_flags` for possible values of *flags*.
419419
*strides*, if given, overrides *order*.
420420

421-
:return: a tuple *(array, event)*. *array* is a
422-
:class:`numpy.ndarray` representing the host side
421+
:return: a tuple *(array, event, row_pitch, slice_pitch)*.
422+
*array* is a :class:`numpy.ndarray` representing the host side
423423
of the map. Its *.base* member contains a
424424
:class:`MemoryMap`.
425425

pyopencl/_cl.pyi

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1528,7 +1528,7 @@ def enqueue_map_image(
15281528
strides: tuple[int, ...] | None = None,
15291529
wait_for: WaitList = None,
15301530
is_blocking: bool = True
1531-
) -> np.ndarray[tuple[int, ...], DTypeT]: ...
1531+
) -> tuple[np.ndarray[tuple[int, ...], DTypeT], Event, int, int]: ...
15321532

15331533
class SVMPointer:
15341534
@property

0 commit comments

Comments
 (0)