Commit 8bd4c3a8 authored by Gregory P. Smith's avatar Gregory P. Smith

Merged revisions 77242 via svnmerge from

svn+ssh://pythondev@svn.python.org/python/trunk

........
  r77242 | gregory.p.smith | 2010-01-02 13:29:54 -0800 (Sat, 02 Jan 2010) | 3 lines

  Correct documentation for s* z* and w*, the argument that should be passed
  is the address of a Py_buffer, not a Py_buffer *.
........
parent 573cdc97
...@@ -46,7 +46,7 @@ of the C variable(s) whose address should be passed. ...@@ -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` :file:`Python.h`. If the macro is defined, length is a :ctype:`Py_ssize_t`
rather than an int. 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 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 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 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. ...@@ -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] ``z#`` (string or ``None`` or any read buffer compatible object) [const char \*, int]
This is to ``s#`` as ``z`` is to ``s``. 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``. This is to ``s*`` as ``z`` is to ``s``.
.. versionadded:: 2.6 .. versionadded:: 2.6
...@@ -266,7 +266,7 @@ of the C variable(s) whose address should be passed. ...@@ -266,7 +266,7 @@ of the C variable(s) whose address should be passed.
buffer. Only single-segment buffer objects are accepted; :exc:`TypeError` buffer. Only single-segment buffer objects are accepted; :exc:`TypeError`
is raised for all others. 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``. This is to ``w`` what ``s*`` is to ``s``.
.. versionadded:: 2.6 .. versionadded:: 2.6
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment