From e1810e0a5bb4a7027330928a4608e910a58e1559 Mon Sep 17 00:00:00 2001
From: Andreas Kloeckner <inform@tiker.net>
Date: Wed, 28 Jun 2017 08:28:16 +0200
Subject: [PATCH] Improve MemoryMap documentation (Closes #185)
---
doc/runtime_memory.rst | 9 +++++++++
pyopencl/cffi_cl.py | 8 +++++---
2 files changed, 14 insertions(+), 3 deletions(-)
diff --git a/doc/runtime_memory.rst b/doc/runtime_memory.rst
index f23a29ae..94d7d197 100644
--- a/doc/runtime_memory.rst
+++ b/doc/runtime_memory.rst
@@ -321,6 +321,15 @@ Mapping Memory into Host Address Space
.. versionchanged:: 2013.2
Added *strides* argument.
+ Sample usage::
+
+ mapped_buf = cl.enqueue_map_buffer(queue, buf, ...)
+ with mapped_buf.base:
+ # work with mapped_buf
+ ...
+
+ # memory will be unmapped here
+
.. function:: enqueue_map_image(queue, buf, flags, origin, region, shape, dtype, order="C", strides=None, wait_for=None, is_blocking=True)
|explain-waitfor|
diff --git a/pyopencl/cffi_cl.py b/pyopencl/cffi_cl.py
index b85400cb..2851b02c 100644
--- a/pyopencl/cffi_cl.py
+++ b/pyopencl/cffi_cl.py
@@ -941,10 +941,12 @@ class MemoryObject(MemoryObjectHolder):
# {{{ MemoryMap
class MemoryMap(_Common):
- """"
- .. automethod:: release
-
+ """
This class may also be used as a context manager in a ``with`` statement.
+ The memory corresponding to this object will be unmapped when
+ this object is deleted or :meth:`release` is called.
+
+ .. automethod:: release
"""
@classmethod
--
GitLab