[ python-Bugs-984017 ] Buffer Protocol Prototypes Incorrect

[SourceForge.net]

Bugs item #984017, was opened at 2004-07-02 14:13
Message generated for change (Tracker Item Submitted) made by Item Submitter
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=984017&group_id=5470

Category: Documentation
Group: Python 2.3
Status: Open
Resolution: None
Priority: 5
Submitted By: Timothy Stranex (perspex)
Assigned to: Nobody/Anonymous (nobody)
Summary: Buffer Protocol Prototypes Incorrect

Initial Comment:
The PyObject_AsReadBuffer and PyObject_AsWriteBuffer
functions are documented incorrectly in the Python/C
API Reference Manual for both Python 2.3 and the
current development documentation.

Section 6.6 ("Buffer Protocol") state the following
prototypes:

    - int PyObject_AsReadBuffer(PyObject *obj, const
char **buffer, int *buffer_len)
    - int PyObject_AsWriteBuffer(PyObject *obj, char
**buffer, int *buffer_len)

while Include/abstract.h define them as follows:

    - int PyObject_AsReadBuffer(PyObject *obj, const
void **buffer, int *buffer_len)
    - int PyObject_AsWriteBuffer(PyObject *obj, void
**buffer, int *buffer_len);

In each case, "char **buffer" should be changed to
"void **buffer". I've included a patch against Python
2.3.3 in diff -u format that fixes this. It modifies
Doc/api/abstract.tex.

Thanks,
Timothy Stranex

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=984017&group_id=5470