Commit 2408a886 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 4e01c124
...@@ -37,7 +37,7 @@ variable(s) whose address should be passed. ...@@ -37,7 +37,7 @@ variable(s) whose address should be passed.
including :file:`Python.h`. If the macro is defined, length is a including :file:`Python.h`. If the macro is defined, length is a
:ctype:`Py_ssize_t` rather than an int. :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]
This is similar to ``s``, but the code fills a :ctype:`Py_buffer` structure This is similar to ``s``, but the code fills a :ctype:`Py_buffer` structure
provided by the caller. In this case the Python string may contain embedded provided by the caller. In this case the Python string may contain embedded
null bytes. Unicode objects pass back a pointer to the default encoded null bytes. Unicode objects pass back a pointer to the default encoded
...@@ -81,7 +81,7 @@ variable(s) whose address should be passed. ...@@ -81,7 +81,7 @@ variable(s) whose address should be passed.
Like ``s``, but the Python object may also be ``None``, in which case the C Like ``s``, but the Python object may also be ``None``, in which case the C
pointer is set to *NULL*. pointer is set to *NULL*.
``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``.
``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]
...@@ -281,7 +281,7 @@ variable(s) whose address should be passed. ...@@ -281,7 +281,7 @@ variable(s) whose address should be passed.
or use ``w#`` instead. Only single-segment buffer objects are accepted; or use ``w#`` instead. Only single-segment buffer objects are accepted;
:exc:`TypeError` is raised for all others. :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``. This is to ``w`` what ``s*`` is to ``s``.
``w#`` (read-write character buffer) [char \*, int] ``w#`` (read-write character buffer) [char \*, int]
......
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