From c30d39cd7ab48de6cd0fce00b8682b43ac3b91a5 Mon Sep 17 00:00:00 2001 From: Owain Davies <116417456+OTheDev@users.noreply.github.com> Date: Tue, 21 Feb 2023 17:24:33 +0700 Subject: [PATCH] gh-101777: Make `PriorityQueue` docs slightly clearer (GH-102026) Adjust wording slightly, and use min(entries) instead of sorted(list(entries))[0] as an example. (cherry picked from commit 350ba7c07f8983537883e093c5c623287a2a22e5) Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com> --- Doc/library/queue.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Doc/library/queue.rst b/Doc/library/queue.rst index c67f15e953bccc..46b8e9b18a3c1f 100644 --- a/Doc/library/queue.rst +++ b/Doc/library/queue.rst @@ -57,8 +57,8 @@ The :mod:`queue` module defines the following classes and exceptions: *maxsize* is less than or equal to zero, the queue size is infinite. The lowest valued entries are retrieved first (the lowest valued entry is the - one returned by ``sorted(list(entries))[0]``). A typical pattern for entries - is a tuple in the form: ``(priority_number, data)``. + one that would be returned by ``min(entries)``). A typical pattern for + entries is a tuple in the form: ``(priority_number, data)``. If the *data* elements are not comparable, the data can be wrapped in a class that ignores the data item and only compares the priority number::