From: Nikita Sobolev <mail@sobolevn.me>
Date: Mon, 16 Oct 2023 13:05:09 +0000 (+0300)
Subject: gh-110527: Improve `PySet_Clear` docs (#110528)
X-Git-Tag: v3.13.0a2~457
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=bfc1cd8145db00df23fbbd2ed95324bb96c0b25b;p=thirdparty%2FPython%2Fcpython.git

gh-110527: Improve `PySet_Clear` docs (#110528)
---

diff --git a/Doc/c-api/set.rst b/Doc/c-api/set.rst
index 1e8a09509032..09c0fb6b9c5f 100644
--- a/Doc/c-api/set.rst
+++ b/Doc/c-api/set.rst
@@ -163,4 +163,6 @@ subtypes but not for instances of :class:`frozenset` or its subtypes.
 
 .. c:function:: int PySet_Clear(PyObject *set)
 
-   Empty an existing set of all elements.
+   Empty an existing set of all elements. Return ``0`` on
+   success. Return ``-1`` and raise :exc:`SystemError` if *set* is not an instance of
+   :class:`set` or its subtype.