From: Raymond Hettinger <rhettinger@users.noreply.github.com>
Date: Sat, 3 Feb 2018 21:57:02 +0000 (-0800)
Subject: bpo-32739: Show default value for rotate() (GH-5517)
X-Git-Tag: v2.7.15rc1~62
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=42e8ea9f69c133a4bbb9e496f68a05926b99c2da;p=thirdparty%2FPython%2Fcpython.git

bpo-32739: Show default value for rotate() (GH-5517)

Manual backport of GH-5485
---

diff --git a/Doc/library/collections.rst b/Doc/library/collections.rst
index 25e5e22fa37f..a517a2eecfa9 100644
--- a/Doc/library/collections.rst
+++ b/Doc/library/collections.rst
@@ -311,11 +311,14 @@ counts, but the output will exclude results with counts of zero or less.
 
       .. versionadded:: 2.7
 
-   .. method:: rotate(n)
+   .. method:: rotate(n=1)
 
       Rotate the deque *n* steps to the right.  If *n* is negative, rotate to
-      the left.  Rotating one step to the right is equivalent to:
-      ``d.appendleft(d.pop())``.
+      the left.
+
+      When the deque is empty, rotating one step to the right is equivalent to
+      ``d.appendleft(d.pop())``, and rotating one step to the left is
+      equivalent to ``d.append(d.popleft())``.
 
 
    Deque objects also provide one read-only attribute: