Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2026-04-05 03:21:05 +00:00
Code Issues Projects Releases Packages Wiki Activity

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

Browse source 
(cherry picked from commit 9a0dcc5b2e)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
This commit is contained in:
Łukasz Langa 2021-09-21 22:32:09 +02:00 • committed by Pablo Galindo
parent e1eb03d15f
commit 2e4d66d2e7
No known key found for this signature in database
GPG key ID: FFE87404168BD847
1 changed files with 9 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
Doc/library/functions.rst
View file

@ -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