summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorƁukasz Langa <lukasz@langa.pl>2021-09-21 22:32:09 +0200
committerPablo Galindo <pablogsal@gmail.com>2021-09-29 12:31:06 +0100
commit2e4d66d2e71d36de394e0e7a4e60ed7b6a539933 (patch)
treede9d2d519d6138e28be03ebb668e00dcccdd666b
parente1eb03d15fa543ea7e3275b213fdb2c649b5968e (diff)
downloadcpython-git-2e4d66d2e71d36de394e0e7a4e60ed7b6a539933.tar.gz
[3.10] bpo-45246: Document that sorted() only uses "<" comparisons (GH-28494) (GH-28502)
(cherry picked from commit 9a0dcc5b2e04d9c51350107734f12a1cbc0284a7) Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
-rw-r--r--Doc/library/functions.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 96f77ca33a..f4c3ef4600 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -1603,6 +1603,15 @@ are always available. They are listed here in alphabetical order.
compare equal --- this is helpful for sorting in multiple passes (for
example, sort by department, then by salary grade).
+ The sort algorithm uses only ``<`` comparisons between items. While
+ defining an :meth:`~object.__lt__` method will suffice for sorting,
+ :PEP:`8` recommends that all six :ref:`rich comparisons
+ <comparisons>` be implemented. This will help avoid bugs when using
+ the same data with other ordering tools such as :func:`max` that rely
+ on a different underlying method. Implementing all six comparisons
+ also helps avoid confusion for mixed type comparisons which can call
+ reflected the :meth:`~object.__gt__` method.
+
For sorting examples and a brief sorting tutorial, see :ref:`sortinghowto`.
.. decorator:: staticmethod