From ba40af36148078b96fa8a213769d00504cf55778 Mon Sep 17 00:00:00 2001
From: Andreas Kloeckner <inform@tiker.net>
Date: Wed, 24 Nov 2010 16:53:14 -0500
Subject: [PATCH] Improve docs of image constructor.
---
doc/source/runtime.rst | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/doc/source/runtime.rst b/doc/source/runtime.rst
index 80360d71..f369a266 100644
--- a/doc/source/runtime.rst
+++ b/doc/source/runtime.rst
@@ -394,7 +394,11 @@ Images
^^^^^^
.. class:: Image(context, flags, format, shape=None, pitches=None, hostbuf=None)
- *shape* is a 2- or 3-tuple.
+ See :class:`mem_flags` for values of *flags*.
+ *shape* is a 2- or 3-tuple. *format* is an instance of :class:`ImageFormat`.
+ *pitches* is a 1-tuple for 2D images and a 2-tuple for 3D images, indicating
+ the distance in bytes from one scan line to the next, and from one 2D image
+ slice to the next.
If *hostbuf* is given and *shape* is `None`, then *hostbuf.shape* is
used as the *shape* parameter.
--
GitLab