[Python-checkins] r74960 - in python/branches/py3k: Doc/c-api/bytearray.rst

Sun Sep 20 09:19:57 CEST 2009

Author: ezio.melotti
Date: Sun Sep 20 09:19:57 2009
New Revision: 74960
Log:
Merged revisions 74958 via svnmerge from 
svn+ssh://pythondev@svn.python.org/python/trunk
........
 r74958 | ezio.melotti | 2009年09月20日 10:10:39 +0300 (2009年9月20日) | 1 line
 
 #6881 - fixed wrong return type; improved the formatting
........
Modified:
 python/branches/py3k/ (props changed)
 python/branches/py3k/Doc/c-api/bytearray.rst
Modified: python/branches/py3k/Doc/c-api/bytearray.rst
==============================================================================

--- python/branches/py3k/Doc/c-api/bytearray.rst	(original)
+++ python/branches/py3k/Doc/c-api/bytearray.rst	Sun Sep 20 09:19:57 2009
@@ -18,6 +18,8 @@
 This instance of :ctype:`PyTypeObject` represents the Python bytearray type;
 it is the same object as ``bytearray`` in the Python layer.
 
+Type check macros
+^^^^^^^^^^^^^^^^^
 
 .. cfunction:: int PyByteArray_Check(PyObject *o)
 
@@ -31,6 +33,9 @@
 subtype of the bytearray type.
 
 
+Direct API functions
+^^^^^^^^^^^^^^^^^^^^
+
 .. cfunction:: PyObject* PyByteArray_FromObject(PyObject *o)
 
 Return a new bytearray object from any object, *o*, that implements the
@@ -45,14 +50,14 @@
 failure, *NULL* is returned.
 
 
-.. cfunction:: Py_ssize_t PyByteArray_Size(PyObject *bytearray)
+.. cfunction:: PyObject* PyByteArray_Concat(PyObject *a, PyObject *b)
 
- Return the size of *bytearray* after checking for a *NULL* pointer.
+ Concat bytearrays *a* and *b* and return a new bytearray with the result.
 
 
-.. cfunction:: Py_ssize_t PyByteArray_GET_SIZE(PyObject *bytearray)
+.. cfunction:: Py_ssize_t PyByteArray_Size(PyObject *bytearray)
 
- Macro version of :cfunc:`PyByteArray_Size` that doesn't do pointer checking.
+ Return the size of *bytearray* after checking for a *NULL* pointer.
 
 
 .. cfunction:: char* PyByteArray_AsString(PyObject *bytearray)
@@ -61,16 +66,20 @@
 *NULL* pointer.
 
 
-.. cfunction:: char* PyByteArray_AS_STRING(PyObject *bytearray)
+.. cfunction:: int PyByteArray_Resize(PyObject *bytearray, Py_ssize_t len)
 
- Macro version of :cfunc:`PyByteArray_AsString` that doesn't check pointers.
+ Resize the internal buffer of *bytearray* to *len*.
 
+Macros
+^^^^^^
 
-.. cfunction:: PyObject* PyByteArray_Concat(PyObject *a, PyObject *b)
+These macros trade safety for speed and they don't check pointers.
 
- Concat bytearrays *a* and *b* and return a new bytearray with the result.
+.. cfunction:: char* PyByteArray_AS_STRING(PyObject *bytearray)
 
+ Macro version of :cfunc:`PyByteArray_AsString`.
 
-.. cfunction:: PyObject* PyByteArray_Resize(PyObject *bytearray, Py_ssize_t len)
 
- Resize the internal buffer of *bytearray* to *len*.
+.. cfunction:: Py_ssize_t PyByteArray_GET_SIZE(PyObject *bytearray)
+
+ Macro version of :cfunc:`PyByteArray_Size`.
