From: Mariatta <Mariatta@users.noreply.github.com>
Date: Wed, 6 Sep 2017 01:13:07 +0000 (-0700)
Subject: [3.6] bpo-30662: fixed OrderedDict.__init__ docstring re PEP 468 (GH-2179) (GH-3370)
X-Git-Tag: v3.6.3rc1~86
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=3b9d4444fe631117430dee8ef8a2f205b4b450d5;p=python

[3.6] bpo-30662: fixed OrderedDict.__init__ docstring re PEP 468 (GH-2179) (GH-3370)

* 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
(cherry picked from commit faa57cbe7074b26807cd7ed89a7b173b5cbf3086)
---

diff --git a/Lib/collections/__init__.py b/Lib/collections/__init__.py
index 85b4c3c19a..1d6822a3a0 100644
--- a/Lib/collections/__init__.py
+++ b/Lib/collections/__init__.py
@@ -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 "
diff --git a/Objects/odictobject.c b/Objects/odictobject.c
index f9f1bf362e..9e891152af 100644
--- a/Objects/odictobject.c
+++ b/Objects/odictobject.c
@@ -875,8 +875,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\
         ");