Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

bpo-45246: Document that sorted() only uses "<" comparisons (GH-28494)

This commit is contained in:
Raymond Hettinger 2021-09-21 12:26:27 -05:00 committed by GitHub
parent a356272362
commit 9a0dcc5b2e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Doc/library/functions.rst
View File

@ -1592,6 +1592,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