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

Tue Sep 5 21:13:09 EDT 2017

https://github.com/python/cpython/commit/3b9d4444fe631117430dee8ef8a2f205b4b450d5
commit: 3b9d4444fe631117430dee8ef8a2f205b4b450d5
branch: 3.6
author: Mariatta <Mariatta at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2017年09月05日T18:13:07-07:00
summary:
[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)
files:
M Lib/collections/__init__.py
M Objects/odictobject.c

diff --git a/Lib/collections/__init__.py b/Lib/collections/__init__.py
index 85b4c3c19ac..1d6822a3a0b 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 f9f1bf362e7..9e891152aff 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\
 ");
 


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

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