From 2a0f7c34c386dc80519da6c3fb150f081943f204 Mon Sep 17 00:00:00 2001 From: Henk-Jaap Wagenaar Date: Mon, 11 Sep 2017 02:11:18 +0100 Subject: Backport docstring improvements to OrderedDict. (GH-3470) --- Lib/collections/__init__.py | 4 ++-- Objects/odictobject.c | 10 ++++++---- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/Lib/collections/__init__.py b/Lib/collections/__init__.py index 1d6822a..26aeac1 100644 --- a/Lib/collections/__init__.py +++ b/Lib/collections/__init__.py @@ -155,9 +155,9 @@ class OrderedDict(dict): dict.clear(self) def popitem(self, last=True): - '''od.popitem() -> (k, v), return and remove a (key, value) pair. - Pairs are returned in LIFO order if last is true or FIFO order if false. + '''Remove and return a (key, value) pair from the dictionary. + Pairs are returned in LIFO order if last is true or FIFO order if false. ''' if not self: raise KeyError('dictionary is empty') diff --git a/Objects/odictobject.c b/Objects/odictobject.c index 9e89115..65f90e8 100644 --- a/Objects/odictobject.c +++ b/Objects/odictobject.c @@ -1154,10 +1154,12 @@ _odict_popkey(PyObject *od, PyObject *key, PyObject *failobj) /* popitem() */ PyDoc_STRVAR(odict_popitem__doc__, -"od.popitem() -> (k, v), return and remove a (key, value) pair.\n\ - Pairs are returned in LIFO order if last is true or FIFO order if false.\n\ -\n\ - "); +"popitem($self, /, last=True)\n" +"--\n" +"\n" +"Remove and return a (key, value) pair from the dictionary.\n" +"\n" +"Pairs are returned in LIFO order if last is true or FIFO order if false."); static PyObject * odict_popitem(PyObject *od, PyObject *args, PyObject *kwargs) -- cgit v0.12