]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.11] gh-110527: Improve `PySet_Clear` docs (GH-110528) (#110927)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Mon, 16 Oct 2023 13:15:07 +0000 (15:15 +0200)
committerGitHub <noreply@github.com>
Mon, 16 Oct 2023 13:15:07 +0000 (13:15 +0000)
gh-110527: Improve `PySet_Clear` docs (GH-110528)
(cherry picked from commit bfc1cd8145db00df23fbbd2ed95324bb96c0b25b)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Doc/c-api/set.rst

index 1e8a09509032f52d9cf6e608a3d23e514e2f24b6..09c0fb6b9c5f233cef91971d3a8ebfda3d1dde4c 100644 (file)
@@ -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.