From: Eli Bendersky <eliben@gmail.com>
Date: Sun, 3 Jun 2012 03:47:53 +0000 (+0300)
Subject: Issue #14424: Document PyType_GenericAlloc, and fix the documentation of PyType_Gener... 
X-Git-Tag: v3.3.0b1~296^2~2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=11cfea92950eda064e9b5b7048c1951bb084fc43;p=thirdparty%2FPython%2Fcpython.git

Issue #14424: Document PyType_GenericAlloc, and fix the documentation of PyType_GenericNew
---

diff --git a/Doc/c-api/type.rst b/Doc/c-api/type.rst
index cfd0d7880906..ce39e4dbac79 100644
--- a/Doc/c-api/type.rst
+++ b/Doc/c-api/type.rst
@@ -70,13 +70,14 @@ Type Objects
 
 .. c:function:: PyObject* PyType_GenericAlloc(PyTypeObject *type, Py_ssize_t nitems)
 
-   XXX: Document.
-
+   Generic handler for the :attr:`tp_alloc` slot of a type object.  Use
+   Python's default memory allocation mechanism to allocate a new instance and
+   initialize all its contents to *NULL*.
 
 .. c:function:: PyObject* PyType_GenericNew(PyTypeObject *type, PyObject *args, PyObject *kwds)
 
-   Generic handler for the :attr:`tp_new` slot of a type object.  Initialize
-   all instance variables to *NULL*.
+   Generic handler for the :attr:`tp_new` slot of a type object.  Create a
+   new instance using the type's :attr:`tp_alloc` slot.
 
 .. c:function:: int PyType_Ready(PyTypeObject *type)