summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorGregory P. Smith <greg@mad-scientist.com>2010-01-02 21:29:54 (GMT)
committerGregory P. Smith <greg@mad-scientist.com>2010-01-02 21:29:54 (GMT)
commitb56fb12b74b5e4123061b0e9a09043479614ab9f (patch)
tree3dea18878201c14cc29b5d3f19a056c3ee0ebb88 /Doc
parent5b7139aab41becad7ad736bd9ff2332960bf67f9 (diff)
downloadcpython-b56fb12b74b5e4123061b0e9a09043479614ab9f.zip
cpython-b56fb12b74b5e4123061b0e9a09043479614ab9f.tar.gz
cpython-b56fb12b74b5e4123061b0e9a09043479614ab9f.tar.bz2
Correct documentation for s* z* and w*, the argument that should be passed
is the address of a Py_buffer, not a Py_buffer *.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/c-api/arg.rst6
1 files changed, 3 insertions, 3 deletions
diff --git a/Doc/c-api/arg.rst b/Doc/c-api/arg.rst
index 4774861..2ffba93 100644
--- a/Doc/c-api/arg.rst
+++ b/Doc/c-api/arg.rst
@@ -46,7 +46,7 @@ of the C variable(s) whose address should be passed.
:file:`Python.h`. If the macro is defined, length is a :ctype:`Py_ssize_t`
rather than an int.
-``s*`` (string, Unicode, or any buffer compatible object) [Py_buffer \*]
+``s*`` (string, Unicode, or any buffer compatible object) [Py_buffer]
Similar to ``s#``, this code fills a Py_buffer structure provided by the
caller. The buffer gets locked, so that the caller can subsequently use
the buffer even inside a ``Py_BEGIN_ALLOW_THREADS`` block; the caller is
@@ -62,7 +62,7 @@ of the C variable(s) whose address should be passed.
``z#`` (string or ``None`` or any read buffer compatible object) [const char \*, int]
This is to ``s#`` as ``z`` is to ``s``.
-``z*`` (string or ``None`` or any buffer compatible object) [Py_buffer*]
+``z*`` (string or ``None`` or any buffer compatible object) [Py_buffer]
This is to ``s*`` as ``z`` is to ``s``.
.. versionadded:: 2.6
@@ -266,7 +266,7 @@ of the C variable(s) whose address should be passed.
buffer. Only single-segment buffer objects are accepted; :exc:`TypeError`
is raised for all others.
-``w*`` (read-write byte-oriented buffer) [Py_buffer \*]
+``w*`` (read-write byte-oriented buffer) [Py_buffer]
This is to ``w`` what ``s*`` is to ``s``.
.. versionadded:: 2.6