From 07528d1f855cf7a970913477b40c664700a0aa4d Mon Sep 17 00:00:00 2001 From: Brett Cannon Date: Sun, 16 May 2021 20:11:44 -0700 Subject: [PATCH] docs/library: Clarify what type of algorithm is implemented in heapq. --- docs/library/uheapq.rst | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/library/uheapq.rst b/docs/library/uheapq.rst index f822f1e7f3..9ae1f61a17 100644 --- a/docs/library/uheapq.rst +++ b/docs/library/uheapq.rst @@ -6,9 +6,11 @@ |see_cpython_module| :mod:`python:heapq`. -This module implements the heap queue algorithm. +This module implements the +`min heap queue algorithm `_. -A heap queue is simply a list that has its elements stored in a certain way. +A heap queue is essentially a list that has its elements stored in such a way +that the first item of the list is always the smallest. Functions --------- @@ -19,8 +21,10 @@ Functions .. function:: heappop(heap) - Pop the first item from the ``heap``, and return it. Raises IndexError if - heap is empty. + Pop the first item from the ``heap``, and return it. Raise ``IndexError`` if + ``heap`` is empty. + + The returned item will be the smallest item in the ``heap``. .. function:: heapify(x)