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

589c718a · Raymond Hettinger · GitHub · 38bfa841 · 589c718a
Commit 589c718a authored Feb 03, 2018 by Raymond Hettinger Committed by GitHub Feb 03, 2018
Show whitespace changes
Inline Side-by-side

Showing with 7 additions and 4 deletions

Doc/library/collections.rst Doc/library/collections.rst +7 -4

No files found.
--- a/Doc/library/collections.rst
+++ b/Doc/library/collections.rst
@@ -509,11 +509,14 @@ or subtracting from an empty counter.
        .. versionadded:: 3.2
-    .. method:: rotate(n)
+    .. method:: rotate(n=1)
-        Rotate the deque *n* steps to the right.  If *n* is negative, rotate to
+        Rotate the deque *n* steps to the right.  If *n* is negative, rotate
-        the left.  Rotating one step to the right is equivalent to:
+        to the left.
-        ``d.appendleft(d.pop())``.
+        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: