summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Buitinck <larsmans@gmail.com>2015-02-07 14:00:00 +0100
committerLars Buitinck <larsmans@gmail.com>2015-02-07 14:00:50 +0100
commitff78ab327a8cb805aa219c22f14f59f10bf2a747 (patch)
tree3ad8c771b405ed41c6a59cb1e8f79e0d6603387a
parentd86fba4a2d7d1434808e52fa9765675813088a63 (diff)
downloadcython-ff78ab327a8cb805aa219c22f14f59f10bf2a747.tar.gz
comment some fields in buffer protocol docs
[ci skip]
-rw-r--r--docs/src/userguide/buffer.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/src/userguide/buffer.rst b/docs/src/userguide/buffer.rst
index 0446df7e8..01e61da24 100644
--- a/docs/src/userguide/buffer.rst
+++ b/docs/src/userguide/buffer.rst
@@ -73,16 +73,16 @@ which Cython handles specially.
self.strides[0] = self.ncols * self.strides[1]
buffer.buf = <char *>&(self.v[0])
- buffer.format = 'f'
- buffer.internal = NULL
+ buffer.format = 'f' # float
+ buffer.internal = NULL # see References
buffer.itemsize = itemsize
- buffer.len = self.v.size() * itemsize
+ buffer.len = self.v.size() * itemsize # product(shape) * itemsize
buffer.ndim = 2
buffer.obj = self
buffer.readonly = 0
buffer.shape = self.shape
buffer.strides = self.strides
- buffer.suboffsets = NULL
+ buffer.suboffsets = NULL # for pointer arrays only
def __releasebuffer__(self, Py_buffer *buffer):
pass