From 2b4b5acf185c701ddec09637d9a82d21cd4615c6 Mon Sep 17 00:00:00 2001
From: Benjamin Peterson <benjamin@python.org>
Date: Mon, 26 May 2008 15:54:26 +0000
Subject: [PATCH] add PyByteArray docs

---
 Doc/c-api/bytearray.rst | 74 +++++++++++++++++++++++++++++++++++++++++
 Doc/c-api/concrete.rst  |  1 +
 2 files changed, 75 insertions(+)
 create mode 100644 Doc/c-api/bytearray.rst

diff --git a/Doc/c-api/bytearray.rst b/Doc/c-api/bytearray.rst
new file mode 100644
index 0000000000..1b0f3776aa
--- /dev/null
+++ b/Doc/c-api/bytearray.rst
@@ -0,0 +1,74 @@
+.. highlightlang:: c
+
+.. _bytearrayobjects:
+
+Byte Array Objects
+------------------
+
+.. index:: object: bytearray
+
+
+.. ctype:: PyByteArrayObject
+
+   This subtype of :ctype:`PyObject` represents a Python string object.
+
+
+.. cvar:: PyTypeObject PyByteArray_Type
+
+   This instance of :ctype:`PyTypeObject` represents the Python bytearray type;
+   it is the same object as ``bytearray`` in the Python layer.
+
+
+.. cfunction:: int PyByteArray_Check(PyObject *o)
+
+   Return true if the object *o* is a bytearray object or an instance of a
+   subtype of the bytearray type.
+
+
+.. cfunction:: int PyByteArray_CheckExact(PyObject *o)
+
+   Return true if the object *o* is a bytearray object, but not an instance of a
+   subtype of the bytearray type.
+
+
+.. cfunction:: PyObject* PyByteArray_FromObject(PyObject *o)
+
+   Return a new bytearray object from any object, *o*, that implements the
+   buffer protocol.
+
+
+.. cfunction:: PyObject* PyByteArray_FromStringAndSize(const char *string, Py_ssize_t len)
+
+   Create a new bytearray object from *string* and it's length, *len*.  On
+   failure, *NULL* is returned.
+
+
+.. cfunction:: Py_ssize_t PyByteArray_Size(PyObject *bytearray)
+
+   Return the size of *bytearray* after checking for a *NULL* pointer.
+
+
+.. cfunction:: Py_ssize_t PyByteArray_GET_SIZE(PyObject *bytearray)
+
+   Macro version of :cfunc:`PyByteArray_Size` that doesn't do pointer checking.
+
+
+.. cfunction:: char* PyByteArray_AsString(PyObject *bytearray)
+
+   Return the contents of *bytearray* as a char array after checking for a
+   *NULL* pointer.
+
+
+.. cfunction:: char* PyByteArray_AS_STRING(PyObject *bytearray)
+
+   Macro version of :cfunc:`PyByteArray_AsString` that doesn't check pointers.
+
+
+.. cfunction:: PyObject* PyByteArray_Concat(PyObject *a, PyObject *b)
+
+   Concat bytearrays *a* and *b* and return a new bytearray with the result.
+
+
+.. cfunction:: PyObject* PyByteArray_Resize(PyObject *bytearray, Py_ssize_t len)
+
+   Resize the internal buffer of *bytearray* to *len*.
diff --git a/Doc/c-api/concrete.rst b/Doc/c-api/concrete.rst
index 10f483740a..6958646c18 100644
--- a/Doc/c-api/concrete.rst
+++ b/Doc/c-api/concrete.rst
@@ -64,6 +64,7 @@ intrinsic to the Python language.
 
 .. toctree::
 
+   bytearray.rst
    string.rst
    unicode.rst
    buffer.rst
-- 
2.40.0