]> granicus.if.org Git - python/commitdiff
Closes #18456: Doc fix: PyDict_Update only works with dict-like objects, not key...
authorGeorg Brandl <georg@python.org>
Tue, 25 Mar 2014 08:34:30 +0000 (09:34 +0100)
committerGeorg Brandl <georg@python.org>
Tue, 25 Mar 2014 08:34:30 +0000 (09:34 +0100)
Doc/c-api/dict.rst

index 3e967bdccfca02434bd98f875f32d89fb4f50f1c..3006b6cff91ec87a260e82dcef3fed72249dcb07 100644 (file)
@@ -210,8 +210,11 @@ Dictionary Objects
 
 .. c:function:: int PyDict_Update(PyObject *a, PyObject *b)
 
-   This is the same as ``PyDict_Merge(a, b, 1)`` in C, or ``a.update(b)`` in
-   Python.  Return ``0`` on success or ``-1`` if an exception was raised.
+   This is the same as ``PyDict_Merge(a, b, 1)`` in C, and is similar to
+   ``a.update(b)`` in Python except that :c:func:`PyDict_Update` doesn't fall
+   back to the iterating over a sequence of key value pairs if the second
+   argument has no "keys" attribute.  Return ``0`` on success or ``-1`` if an
+   exception was raised.
 
    .. versionadded:: 2.2