classification
Title: documention buglet for PyBuffer
Type: Stage:
Components: Documentation Versions: Python 3.1, Python 3.2
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: georg.brandl, ronaldoussoren
Priority: normal Keywords: easy

Created on 2009-12-26 15:11 by ronaldoussoren, last changed 2009-12-28 07:59 by georg.brandl. This issue is now closed.

Messages (3)
msg96889 - (view) Author: Ronald Oussoren (ronaldoussoren) * (Python committer) Date: 2009-12-26 15:11
The documentation for bf_getbuffer at <http://www.python.org/doc/3.1/c-
api/typeobj.html#buffer-object-structures> claims:

<quote>
The signature of getbufferproc is int (PyObject *obj, PyObject *view, 
int flags). obj is the object to export, view is the Py_buffer struct to 
fill
</quote>

This is incorrect, the 'view' argument has type 'Py_buffer*'.

The same issue is also present in the 3.2 documentation (and I haven't 
checked the 2.6/2.7 docs yet)
msg96890 - (view) Author: Ronald Oussoren (ronaldoussoren) * (Python committer) Date: 2009-12-26 15:47
Another buffer documentation buglet is the documentation for 
'PyBuffer_FillInfo'. The prototype in the documentation is:

int PyBuffer_FillInfo(Py_buffer *view, void *buf, Py_ssize_t len, int 
readonly, int infoflags)

The real prototype has an additional argument (the second one in the 
prototype below):

int PyBuffer_FillInfo(Py_buffer *view, PyObject *o, void *buf,
                                       Py_ssize_t len, int readonly,
                                       int flags);
msg96938 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2009-12-28 07:59
Thanks, fixed in r77081, r77082.
History
Date User Action Args
2009-12-28 07:59:34georg.brandlsetstatus: open -> closed
resolution: fixed
messages: + msg96938
2009-12-26 15:47:30ronaldoussorensetmessages: + msg96890
title: documention buglet -> documention buglet for PyBuffer
2009-12-26 15:11:54ronaldoussorencreate