Show the function signature in the docstring

This commit is contained in:
Raymond Hettinger 2013-01-18 17:35:25 -08:00
parent 6d043fc781
commit bd8f29028e
1 changed files with 3 additions and 3 deletions

View File

@ -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().");