Show the function signature in the docstring

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

View File

@ -141,7 +141,7 @@ heappush(PyObject *self, PyObject *args)
} }
PyDoc_STRVAR(heappush_doc, 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 * static PyObject *
heappop(PyObject *self, PyObject *heap) heappop(PyObject *self, PyObject *heap)
@ -209,7 +209,7 @@ heapreplace(PyObject *self, PyObject *args)
} }
PyDoc_STRVAR(heapreplace_doc, 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\ \n\
This is more efficient than heappop() followed by heappush(), and can be\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\ more appropriate when using a fixed-size heap. Note that the value\n\
@ -256,7 +256,7 @@ heappushpop(PyObject *self, PyObject *args)
} }
PyDoc_STRVAR(heappushpop_doc, 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\ from the heap. The combined action runs more efficiently than\n\
heappush() followed by a separate call to heappop()."); heappush() followed by a separate call to heappop().");