From: Raymond Hettinger <python@rcn.com>
Date: Sat, 19 Jan 2013 01:35:25 +0000 (-0800)
Subject: Show the function signature in the docstring
X-Git-Tag: v3.4.0a1~1578^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=bd8f29028eab752e8e5c73703218a701028c1a9a;p=python

Show the function signature in the docstring
---

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