]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
sorting howto: Add clarification on < using __lt__ (GH-92010)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 29 Apr 2022 22:26:51 +0000 (15:26 -0700)
committerGitHub <noreply@github.com>
Fri, 29 Apr 2022 22:26:51 +0000 (15:26 -0700)
(cherry picked from commit 53ca774497fde7c5fcf3a84813ea42f95f75c639)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
Doc/howto/sorting.rst

index a8efe65353d6e14b7aa0cb5d4ad7b4aff5245043..be017cfba35ffea0049f3769edf50326ce73bc09 100644 (file)
@@ -287,7 +287,7 @@ Odd and Ends
     >>> standard_way
     [('red', 1), ('red', 2), ('blue', 1), ('blue', 2)]
 
-* The sort routines are guaranteed to use :meth:`__lt__` when making comparisons
+* The sort routines use ``<`` when making comparisons
   between two objects. So, it is easy to add a standard sort order to a class by
   defining an :meth:`__lt__` method::
 
@@ -295,6 +295,9 @@ Odd and Ends
     >>> sorted(student_objects)
     [('dave', 'B', 10), ('jane', 'B', 12), ('john', 'A', 15)]
 
+  However, note that ``<`` can fall back to using :meth:`__gt__` if
+  :meth:`__lt__` is not implemented (see :func:`object.__lt__`).
+
 * Key functions need not depend directly on the objects being sorted. A key
   function can also access external resources. For instance, if the student grades
   are stored in a dictionary, they can be used to sort a separate list of student