]> granicus.if.org Git - python/commitdiff
Correct documentation for s* z* and w*, the argument that should be passed
authorGregory P. Smith <greg@mad-scientist.com>
Sat, 2 Jan 2010 21:29:54 +0000 (21:29 +0000)
committerGregory P. Smith <greg@mad-scientist.com>
Sat, 2 Jan 2010 21:29:54 +0000 (21:29 +0000)
is the address of a Py_buffer, not a Py_buffer *.

Doc/c-api/arg.rst

index 47748611d4029e14e9597e8e95d84c9541f837d0..2ffba939a149ae844c2da6d8fa9b1c17cb1225a9 100644 (file)
@@ -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