[Python-checkins] r71928 - python/trunk/Doc/c-api/objbuffer.rst

[jeroen.ruigrok]

Author: jeroen.ruigrok
Date: Sat Apr 25 22:43:30 2009
New Revision: 71928

Log:
Reformat prior to editing.


Modified:
   python/trunk/Doc/c-api/objbuffer.rst

Modified: python/trunk/Doc/c-api/objbuffer.rst
==============================================================================
--- python/trunk/Doc/c-api/objbuffer.rst	(original)
+++ python/trunk/Doc/c-api/objbuffer.rst	Sat Apr 25 22:43:30 2009
@@ -9,27 +9,28 @@
 This section describes the legacy buffer protocol, which has been introduced
 in Python 1.6. It is still supported but deprecated in the Python 2.x series.
 Python 3.0 introduces a new buffer protocol which fixes weaknesses and
-shortcomings of the protocol, and has been backported to Python 2.6.
-See :ref:`bufferobjects` for more information.
+shortcomings of the protocol, and has been backported to Python 2.6.  See
+:ref:`bufferobjects` for more information.
 
 
 .. cfunction:: int PyObject_AsCharBuffer(PyObject *obj, const char **buffer, Py_ssize_t *buffer_len)
 
    Returns a pointer to a read-only memory location usable as character-based
    input.  The *obj* argument must support the single-segment character buffer
-   interface.  On success, returns ``0``, sets *buffer* to the memory location and
-   *buffer_len* to the buffer length.  Returns ``-1`` and sets a :exc:`TypeError`
-   on error.
+   interface.  On success, returns ``0``, sets *buffer* to the memory location
+   and *buffer_len* to the buffer length.  Returns ``-1`` and sets a
+   :exc:`TypeError` on error.
 
    .. versionadded:: 1.6
 
 
 .. cfunction:: int PyObject_AsReadBuffer(PyObject *obj, const void **buffer, Py_ssize_t *buffer_len)
 
-   Returns a pointer to a read-only memory location containing arbitrary data.  The
-   *obj* argument must support the single-segment readable buffer interface.  On
-   success, returns ``0``, sets *buffer* to the memory location and *buffer_len* to
-   the buffer length.  Returns ``-1`` and sets a :exc:`TypeError` on error.
+   Returns a pointer to a read-only memory location containing arbitrary data.
+   The *obj* argument must support the single-segment readable buffer
+   interface.  On success, returns ``0``, sets *buffer* to the memory location
+   and *buffer_len* to the buffer length.  Returns ``-1`` and sets a
+   :exc:`TypeError` on error.
 
    .. versionadded:: 1.6
 
@@ -45,9 +46,9 @@
 .. cfunction:: int PyObject_AsWriteBuffer(PyObject *obj, void **buffer, Py_ssize_t *buffer_len)
 
    Returns a pointer to a writeable memory location.  The *obj* argument must
-   support the single-segment, character buffer interface.  On success, returns
-   ``0``, sets *buffer* to the memory location and *buffer_len* to the buffer
-   length.  Returns ``-1`` and sets a :exc:`TypeError` on error.
+   support the single-segment, character buffer interface.  On success,
+   returns ``0``, sets *buffer* to the memory location and *buffer_len* to the
+   buffer length.  Returns ``-1`` and sets a :exc:`TypeError` on error.
 
    .. versionadded:: 1.6