summaryrefslogtreecommitdiff
path: root/Modules/_heapqmodule.c
diff options
context:
space:
mode:
authorRaymond Hettinger <python@rcn.com>2013-01-18 17:35:25 -0800
committerRaymond Hettinger <python@rcn.com>2013-01-18 17:35:25 -0800
commitbd8f29028eab752e8e5c73703218a701028c1a9a (patch)
tree91c6c87f5d3181e9974a9e39c233eb565655464d /Modules/_heapqmodule.c
parent6d043fc7813a4d15f1d801e692245b0c1b6759cf (diff)
downloadcpython-git-bd8f29028eab752e8e5c73703218a701028c1a9a.tar.gz
Show the function signature in the docstring
Diffstat (limited to 'Modules/_heapqmodule.c')
-rw-r--r--Modules/_heapqmodule.c6
1 files changed, 3 insertions, 3 deletions
diff --git a/Modules/_heapqmodule.c b/Modules/_heapqmodule.c
index 1066f94b00..c8db509beb 100644
--- a/Modules/_heapqmodule.c
+++ b/Modules/_heapqmodule.c
@@ -118,7 +118,7 @@ heappush(PyObject *self, PyObject *args)
}
PyDoc_STRVAR(heappush_doc,
-"Push item onto heap, maintaining the heap invariant.");
+"heappush(heap, item) -> None. Push item onto heap, maintaining the heap invariant.");
static PyObject *
heappop(PyObject *self, PyObject *heap)
@@ -186,7 +186,7 @@ heapreplace(PyObject *self, PyObject *args)
}
PyDoc_STRVAR(heapreplace_doc,
-"Pop and return the current smallest value, and add the new item.\n\
+"heapreplace(heap, item) -> value. Pop and return the current smallest value, and add the new item.\n\
\n\
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\
@@ -233,7 +233,7 @@ heappushpop(PyObject *self, PyObject *args)
}
PyDoc_STRVAR(heappushpop_doc,
-"Push item on the heap, then pop and return the smallest item\n\
+"heappushpop(heap, item) -> value. Push item on the heap, then pop and return the smallest item\n\
from the heap. The combined action runs more efficiently than\n\
heappush() followed by a separate call to heappop().");