From bdb559e1f003e4d2fd2b21ee22498307bc31aea8 Mon Sep 17 00:00:00 2001
From: Andreas Kloeckner <inform@tiker.net>
Date: Sat, 14 Oct 2017 21:37:46 -0500
Subject: [PATCH] Improve enqueue_fill_buffer documentation (Closes #206 on
github)
---
doc/runtime_memory.rst | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/doc/runtime_memory.rst b/doc/runtime_memory.rst
index 94d7d197..75b60253 100644
--- a/doc/runtime_memory.rst
+++ b/doc/runtime_memory.rst
@@ -98,6 +98,12 @@ Buffer
:arg mem: the on device :class:`Buffer`
:arg pattern: a buffer object (likely a :class:`numpy.ndarray`, eg. `np.uint32(0)`)
+ The memory associated with *pattern* can be reused or freed once the function
+ completes.
+ :arg size: The size in bytes of the region to be filled. Must be a multiple of the
+ size of the pattern.
+ :arg offset: The location in bytes of the region being filled in *mem*.
+ Must be a multiple of the size of the pattern.
Fills a buffer with the provided pattern
--
GitLab