type

pythoncapi · Aug 31, 2018 · 51d6a91 · 51d6a91
1 parent f1c190a
commit 51d6a91
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/doc/type_object.rst b/doc/type_object.rst
@@ -130,3 +130,15 @@ Remove cross-version binary compatibility
 =========================================
 
 See `bpo-32388 <https://bugs.python.org/issue32388>`_.
+
+PyStructSequence_InitType()
+===========================
+
+There are two public APIs for structure sequences that are wrappers around
+``PyType_Ready()`` for initializing a ``PyTypeObject`` in-place:
+
+* ``PyStructSequence_InitType()``
+* ``PyStructSequence_InitType2()``
+
+A third-party developer should prefer ``PyStructSequence_NewType()`` to create
+a type object from an array of ``PyStructSequence_Desc``.