Fix erroneous docstring comment.

This commit is contained in:
Raymond Hettinger 2004-09-06 07:04:09 +00:00
parent 7d3755d2c0
commit 8158e84930
3 changed files with 9 additions and 6 deletions

View file

@ -60,9 +60,10 @@ 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
than \var{item}! That constrains reasonable uses of this routine
unless written as part of a larger expression:
unless written as part of a conditional replacement:
\begin{verbatim}
result = item <= heap[0] and item or heapreplace(heap, item)
if item > heap[0]:
item = heapreplace(heap, item)
\end{verbatim}
\end{funcdesc}

View file

@ -154,9 +154,10 @@ def heapreplace(heap, item):
This is more efficient than heappop() followed by heappush(), and can be
more appropriate when using a fixed-size heap. Note that the value
returned may be larger than item! That constrains reasonable uses of
this routine unless written as part of a larger expression:
this routine unless written as part of a conditional replacement:
result = item <= heap[0] and item or heapreplace(heap, item)
if item > heap[0]:
item = heapreplace(heap, item)
"""
returnitem = heap[0] # raises appropriate IndexError if heap is empty
heap[0] = item

View file

@ -186,8 +186,9 @@ PyDoc_STRVAR(heapreplace_doc,
This is more efficient than heappop() followed by heappush(), and can be\n\
more appropriate when using a fixed-size heap. Note that the value\n\
returned may be larger than item! That constrains reasonable uses of\n\
this routine unless written as part of a larger expression:\n\n\
result = item <= heap[0] and item or heapreplace(heap, item)\n");
this routine unless written as part of a conditional replacement:\n\n\
if item > heap[0]:\n\
item = heapreplace(heap, item)\n");
static PyObject *
heapify(PyObject *self, PyObject *heap)