Skip to content

Commit c151684

Browse files
committed
Document PySet_MINSIZE
1 parent 8f2e924 commit c151684

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

Doc/c-api/set.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,3 +166,15 @@ subtypes but not for instances of :class:`frozenset` or its subtypes.
166166
Empty an existing set of all elements. Return ``0`` on
167167
success. Return ``-1`` and raise :exc:`SystemError` if *set* is not an instance of
168168
:class:`set` or its subtype.
169+
170+
171+
Deprecated API
172+
^^^^^^^^^^^^^^
173+
174+
.. c:macro:: PySet_MINSIZE
175+
176+
This is a :term:`soft deprecated` constant representing the size of a
177+
preallocated table inside :c:type:`PySetObject` instances.
178+
179+
This is documented solely for completeness and not useful to users in any
180+
way. If looking for the size of a set, use :c:func:`PySet_Size` instead.

0 commit comments

Comments
 (0)