]> granicus.if.org Git - python/commitdiff
bpo-30662: fixed OrderedDict.__init__ docstring re PEP 468 (#2179)
authorJonathan Eunice <jonathan.eunice@gmail.com>
Tue, 5 Sep 2017 23:23:49 +0000 (19:23 -0400)
committerRaymond Hettinger <rhettinger@users.noreply.github.com>
Tue, 5 Sep 2017 23:23:49 +0000 (16:23 -0700)
* fixed OrderedDict.__init__ docstring re PEP 468

* tightened comment and mirrored to C impl

* added space after period per marco-buttu

* preserved substituted for stable

* drop references to Python 3.6 and PEP 468

Lib/collections/__init__.py
Objects/odictobject.c

index 8408255d27ea6a930534149ec6234d272ae8afaa..70cb683088be091ec28f75618fa7b170078754fd 100644 (file)
@@ -85,9 +85,7 @@ class OrderedDict(dict):
 
     def __init__(*args, **kwds):
         '''Initialize an ordered dictionary.  The signature is the same as
-        regular dictionaries, but keyword arguments are not recommended because
-        their insertion order is arbitrary.
-
+        regular dictionaries.  Keyword argument order is preserved.
         '''
         if not args:
             raise TypeError("descriptor '__init__' of 'OrderedDict' object "
index c3d1a09584e5846b1bd12d90f982246e7420aa65..e1ee53beae6e91f27b8ee1fcb885d87ea6a420da 100644 (file)
@@ -882,8 +882,7 @@ odict_eq(PyObject *a, PyObject *b)
 
 PyDoc_STRVAR(odict_init__doc__,
 "Initialize an ordered dictionary.  The signature is the same as\n\
-        regular dictionaries, but keyword arguments are not recommended because\n\
-        their insertion order is arbitrary.\n\
+        regular dictionaries.  Keyword argument order is preserved.\n\
 \n\
         ");