From: Jeroen Ruigrok van der Werven <asmodai@in-nomine.org>
Date: Sat, 25 Apr 2009 11:59:09 +0000 (+0000)
Subject: First attempt to document PyObject_HEAD_INIT and PyVarObject_HEAD_INIT.
X-Git-Tag: v2.7a1~1416
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=162641a24cf2228246a9b8d5e0ca415a32444d5f;p=thirdparty%2FPython%2Fcpython.git

First attempt to document PyObject_HEAD_INIT and PyVarObject_HEAD_INIT.
---

diff --git a/Doc/c-api/structures.rst b/Doc/c-api/structures.rst
index 16552700057d..c4fb218749bc 100644
--- a/Doc/c-api/structures.rst
+++ b/Doc/c-api/structures.rst
@@ -68,7 +68,24 @@ These macros are used in the definition of :ctype:`PyObject` and
    Note that :cmacro:`PyObject_HEAD` is part of the expansion, and that its own
    expansion varies depending on the definition of :cmacro:`Py_TRACE_REFS`.
 
-PyObject_HEAD_INIT
+
+.. cmacro:: PyObject_HEAD_INIT(type)
+
+   This is a macro which expands to initialization values for a new
+   :ctype:`PyObject` type.  This macro expands to::
+
+      _PyObject_EXTRA_INIT
+      1, type,
+
+
+.. cmacro:: PyVarObject_HEAD_INIT(type, size)
+
+   This is a macro which expands to initialization values for a new
+   :ctype:`PyVarObject` type, including the :attr:`ob_size` field.
+   This macro expands to::
+
+      _PyObject_EXTRA_INIT
+      1, type, size,
 
 
 .. ctype:: PyCFunction