From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Mon, 16 Oct 2023 13:14:52 +0000 (+0200)
Subject: [3.12] gh-110527: Improve `PySet_Clear` docs (GH-110528) (#110928)
X-Git-Tag: v3.12.1~283
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=b4ed73042efc545759808558ba5deebd1e0618e5;p=thirdparty%2FPython%2Fcpython.git

[3.12] gh-110527: Improve `PySet_Clear` docs (GH-110528) (#110928)

gh-110527: Improve `PySet_Clear` docs (GH-110528)
(cherry picked from commit bfc1cd8145db00df23fbbd2ed95324bb96c0b25b)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
---

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.