diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2023-10-16 13:15:07 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-10-16 13:15:07 (GMT) |
| commit | 616862d58e41da4493619d8dac8b3dc372a1d789 (patch) | |
| tree | 1526b81a2461bc542a0f30a78a7d080904f4689d | |
| parent | e60abeea30c004cfe0dd619554e013ad76cf1dc2 (diff) | |
| download | cpython-616862d58e41da4493619d8dac8b3dc372a1d789.zip cpython-616862d58e41da4493619d8dac8b3dc372a1d789.tar.gz cpython-616862d58e41da4493619d8dac8b3dc372a1d789.tar.bz2 | |
[3.11] gh-110527: Improve `PySet_Clear` docs (GH-110528) (#110927)
gh-110527: Improve `PySet_Clear` docs (GH-110528)
(cherry picked from commit bfc1cd8145db00df23fbbd2ed95324bb96c0b25b)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
| -rw-r--r-- | Doc/c-api/set.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Doc/c-api/set.rst b/Doc/c-api/set.rst index 1e8a095..09c0fb6 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. |