From: Raymond Hettinger <python@rcn.com>
Date: Thu, 14 Feb 2008 13:34:38 +0000 (+0000)
Subject: Note the the sort arguments are required to be keywords.
X-Git-Tag: v3.0a3~56
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=7f73295966733ba99581c660944e8894f753edcc;p=thirdparty%2FPython%2Fcpython.git

Note the the sort arguments are required to be keywords.
---

diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst
index c90b0a5f30d3..58905e03e503 100644
--- a/Doc/library/stdtypes.rst
+++ b/Doc/library/stdtypes.rst
@@ -1266,7 +1266,7 @@ Note that while lists allow their items to be of any type, bytearray object
 | ``s.reverse()``              | reverses the items of *s* in   | \(6)                |
 |                              | place                          |                     |
 +------------------------------+--------------------------------+---------------------+
-| ``s.sort([key[, reverse]])`` | sort the items of *s* in place | (6), (7)            |
+| ``s.sort([key[, reverse]])`` | sort the items of *s* in place | (6), (7), (8)       |
 +------------------------------+--------------------------------+---------------------+
 
 .. index::
@@ -1315,10 +1315,8 @@ Notes:
    sequence.
 
 (7)
-   :meth:`sort` is not supported by :class:`bytearray` objects.
-
    The :meth:`sort` method takes optional arguments for controlling the
-   comparisons.
+   comparisons.  Each must be specified as a keyword argument.
 
    *key* specifies a function of one argument that is used to extract a comparison
    key from each list element: ``key=str.lower``.  The default value is ``None``.
@@ -1336,6 +1334,8 @@ Notes:
    makes the list appear empty for the duration, and raises :exc:`ValueError` if it
    can detect that the list has been mutated during a sort.
 
+(8)
+   :meth:`sort` is not supported by :class:`bytearray` objects.
 
 .. _bytes-methods: