]> granicus.if.org Git - python/commitdiff
Show the function signature in the docstring
authorRaymond Hettinger <python@rcn.com>
Sat, 19 Jan 2013 01:35:25 +0000 (17:35 -0800)
committerRaymond Hettinger <python@rcn.com>
Sat, 19 Jan 2013 01:35:25 +0000 (17:35 -0800)
Modules/_heapqmodule.c

index 1066f94b002a8b56297b336bddcf312039e9ff25..c8db509bebb0824c1e9c8c8a9fabf17350e7cb9e 100644 (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().");