From 041a7eea88852fad791cc8be1419d3e48e58ba29 Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Thu, 31 Jan 2019 09:48:55 -0600 Subject: [PATCH] Fix docs for ImmediateAllocator (closes #265 on github) --- doc/tools.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/tools.rst b/doc/tools.rst index 967b8d34..ade730a1 100644 --- a/doc/tools.rst +++ b/doc/tools.rst @@ -57,10 +57,10 @@ not complicated:: .. class:: ImmediateAllocator(queue, mem_flags=pyopencl.mem_flags.READ_WRITE) *mem_flags* takes its values from :class:`pyopencl.mem_flags` and corresponds - to the *flags* argument of :class:`pyopencl.Buffer`. DeferredAllocator - has the same semantics as regular OpenCL buffer allocation, i.e. it may - promise memory to be available that later on (in any call to a buffer-using - CL function). + to the *flags* argument of :class:`pyopencl.Buffer`. + :class:`ImmediateAllocator` will attempt to ensure at allocation time that + allocated memory is actually available. If no memory is available, an out-of-memory + error is reported at allocation time. .. versionadded:: 2013.1 -- GitLab