From: Guido van Rossum <guido@python.org>
Date: Wed, 7 Aug 2002 18:56:08 +0000 (+0000)
Subject: Document that heappop() and heapreplace() raise IndexError if the heap
X-Git-Tag: v2.3c1~4630
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=b2865919cc150d3cf682d06ccc99d8de285b1de3;p=python

Document that heappop() and heapreplace() raise IndexError if the heap
is empty.
---

diff --git a/Doc/lib/libheapq.tex b/Doc/lib/libheapq.tex
index 38c38d816d..38f9b1a441 100644
--- a/Doc/lib/libheapq.tex
+++ b/Doc/lib/libheapq.tex
@@ -45,7 +45,7 @@ heap invariant.
 
 \begin{funcdesc}{heappop}{heap}
 Pop and return the smallest item from the \var{heap}, maintaining the
-heap invariant.
+heap invariant.  If the heap is empty, \exception{IndexError} is raised.
 \end{funcdesc}
 
 \begin{funcdesc}{heapify}{x}
@@ -55,6 +55,7 @@ Transform list \var{x} into a heap, in-place, in linear time.
 \begin{funcdesc}{heapreplace}{heap, item}
 Pop and return the smallest item from the \var{heap}, and also push
 the new \var{item}.  The heap size doesn't change.
+If the heap is empty, \exception{IndexError} is raised.
 This is more efficient than \function{heappop()} followed
 by  \function{heappush()}, and can be more appropriate when using
 a fixed-size heap.  Note that the value returned may be larger