From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Fri, 2 Oct 2020 16:39:20 +0000 (-0700)
Subject: bpo-41802: Document 'PyDict_DelItem' can raise a 'KeyError' (GH-22291)
X-Git-Tag: v3.9.1rc1~214
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=6dc8e0eb9b471f6665f841216a6b2d83741b3973;p=thirdparty%2FPython%2Fcpython.git

bpo-41802: Document 'PyDict_DelItem' can raise a 'KeyError' (GH-22291)

(cherry picked from commit 20ce62f00957d11f24f6449cd5c0ef5dd67174d4)

Co-authored-by: Campbell Barton <ideasman42@gmail.com>
---

diff --git a/Doc/c-api/dict.rst b/Doc/c-api/dict.rst
index 6b3f45e27a3c..8c626c7d4a94 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)