Skip to content
Snippets Groups Projects
Commit a37681d4 authored by Andreas Klöckner's avatar Andreas Klöckner
Browse files

Add advice about keeping NannyEvents to enqueue_copy doc (Thanks, Yves Surrel)

parent 680f909e
No related branches found
No related tags found
No related merge requests found
Pipeline #19948 passed with warnings
......@@ -1529,10 +1529,17 @@ def enqueue_copy(queue, dest, src, **kwargs):
:arg wait_for: (optional, default empty)
:arg is_blocking: Wait for completion. Defaults to *True*.
(Available on any copy involving host memory)
:return: A :class:`NannyEvent` if the transfer involved a
host-side buffer, otherwise an :class:`Event`.
.. note::
Be aware that when the deletion of the :class:`NannyEvent` that is
returned by the function if the transfer involved a host-side buffer
will block until the transfer is complete, so be sure to keep a
reference to this :class:`Event` as long as necessary for the
transfer to complete.
.. note::
Two types of 'buffer' occur in the arguments to this function,
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment