Commit 4b017bba authored by Ezio Melotti's avatar Ezio Melotti

#6881 - fixed wrong return type; improved the formatting

parent 14a2e2f6
...@@ -20,6 +20,8 @@ Byte Array Objects ...@@ -20,6 +20,8 @@ Byte Array Objects
This instance of :ctype:`PyTypeObject` represents the Python bytearray type; This instance of :ctype:`PyTypeObject` represents the Python bytearray type;
it is the same object as ``bytearray`` in the Python layer. it is the same object as ``bytearray`` in the Python layer.
Type check macros
^^^^^^^^^^^^^^^^^
.. cfunction:: int PyByteArray_Check(PyObject *o) .. cfunction:: int PyByteArray_Check(PyObject *o)
...@@ -33,6 +35,9 @@ Byte Array Objects ...@@ -33,6 +35,9 @@ Byte Array Objects
subtype of the bytearray type. subtype of the bytearray type.
Direct API functions
^^^^^^^^^^^^^^^^^^^^
.. cfunction:: PyObject* PyByteArray_FromObject(PyObject *o) .. cfunction:: PyObject* PyByteArray_FromObject(PyObject *o)
Return a new bytearray object from any object, *o*, that implements the Return a new bytearray object from any object, *o*, that implements the
...@@ -47,14 +52,14 @@ Byte Array Objects ...@@ -47,14 +52,14 @@ Byte Array Objects
failure, *NULL* is returned. 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) .. cfunction:: char* PyByteArray_AsString(PyObject *bytearray)
...@@ -63,16 +68,20 @@ Byte Array Objects ...@@ -63,16 +68,20 @@ Byte Array Objects
*NULL* pointer. *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`.
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