summaryrefslogtreecommitdiffstats
path: root/Doc/c-api
diff options
context:
space:
mode:
authorCampbell Barton <ideasman42@gmail.com>2020-10-02 16:18:01 (GMT)
committerGitHub <noreply@github.com>2020-10-02 16:18:01 (GMT)
commit20ce62f00957d11f24f6449cd5c0ef5dd67174d4 (patch)
tree5b94ee7e1ff145cc5bcc2acbbecbbeb8a8f2ec83 /Doc/c-api
parent583ee5a5b1971a18ebeb877948ce6264da0cc8aa (diff)
downloadcpython-20ce62f00957d11f24f6449cd5c0ef5dd67174d4.zip
cpython-20ce62f00957d11f24f6449cd5c0ef5dd67174d4.tar.gz
cpython-20ce62f00957d11f24f6449cd5c0ef5dd67174d4.tar.bz2
bpo-41802: Document 'PyDict_DelItem' can raise a 'KeyError' (GH-22291)
Diffstat (limited to 'Doc/c-api')
-rw-r--r--Doc/c-api/dict.rst10
1 files changed, 6 insertions, 4 deletions
diff --git a/Doc/c-api/dict.rst b/Doc/c-api/dict.rst
index 7694841..8e0d684 100644
--- a/Doc/c-api/dict.rst
+++ b/Doc/c-api/dict.rst
@@ -81,14 +81,16 @@ Dictionary Objects
.. c:function:: int PyDict_DelItem(PyObject *p, PyObject *key)
Remove the entry in dictionary *p* with key *key*. *key* must be hashable;
- if it isn't, :exc:`TypeError` is raised. Return ``0`` on success or ``-1``
- on failure.
+ if it isn't, :exc:`TypeError` is raised.
+ If *key* is not in the dictionary, :exc:`KeyError` is raised.
+ Return ``0`` on success or ``-1`` on failure.
.. c:function:: int PyDict_DelItemString(PyObject *p, const char *key)
- Remove the entry in dictionary *p* which has a key specified by the string
- *key*. Return ``0`` on success or ``-1`` on failure.
+ Remove the entry in dictionary *p* which has a key specified by the string *key*.
+ If *key* is not in the dictionary, :exc:`KeyError` is raised.
+ Return ``0`` on success or ``-1`` on failure.
.. c:function:: PyObject* PyDict_GetItem(PyObject *p, PyObject *key)