Concatentation subsequent function docstrings rather than replace the original.

Jonathan Brandmeyer · Jonathan Brandmeyer · commit 4d50bf0ad9c7 · 2005-02-11T20:03:13.000Z
[SVN r27332]
diff --git a/doc/v2/class.html b/doc/v2/class.html
@@ -462,7 +462,9 @@ <h4><a name="class_-spec-modifiers"></a>Class template
                 <td>Any <a href="definitions.html#ntbs">ntbs</a>.</td>
 
                 <td>Value will be bound to the <code>__doc__</code> attribute
-                of the resulting method overload.</td>
+                of the resulting method overload. If an earlier overload 
+                supplied a docstring, two newline characters and the new
+                docstring are appended to it.</td>
               </tr>
 
               <tr>
diff --git a/src/object/function.cpp b/src/object/function.cpp
@@ -472,7 +472,12 @@ void function::add_to_namespace(
     if (doc != 0)
     {
         object attr_copy(attribute);
-        attr_copy.attr("__doc__") = doc;
+        if (PyObject_HasAttrString(attr_copy.ptr(), "__doc__") && attr_copy.attr("__doc__")) {
+            attr_copy.attr("__doc__") += "\n\n";
+            attr_copy.attr("__doc__") += doc;
+        }
+        else
+            attr_copy.attr("__doc__") = doc;
     }
 }
 
diff --git a/test/docstring.cpp b/test/docstring.cpp
@@ -47,6 +47,8 @@ BOOST_PYTHON_MODULE(docstring_ext)
         )
         .def("value", &X::value,
              "gets the value of the object")
+        .def( "value", &X::value,
+            "also gets the value of the object")
         ;
 
     def("create", create, return_value_policy<manage_new_object>(),
diff --git a/test/docstring.py b/test/docstring.py
@@ -15,16 +15,20 @@
 this is the __init__ function
 its documentation has two lines.
 
->>> printdoc(X.value)
-gets the value of the object
-
 >>> printdoc(create)
 creates a new X object
 
 >>> printdoc(fact)
 compute the factorial
 '''
 
+def check_double_string():
+	"""
+	>>> assert check_double_string() == True
+	"""
+	from docstring_ext import X
+	return X.value.__doc__ == "gets the value of the object\n\nalso gets the value of the object"
+
 def run(args = None):
     import sys
     import doctest

Original file line number	Diff line number	Diff line change
`@@ -472,7 +472,12 @@ void function::add_to_namespace(`
`472`	`472`	`if (doc != 0)`
`473`	`473`	`{`
`474`	`474`	`object attr_copy(attribute);`
`475`		`- attr_copy.attr("__doc__") = doc;`
	`475`	`+ if (PyObject_HasAttrString(attr_copy.ptr(), "__doc__") && attr_copy.attr("__doc__")) {`
	`476`	`+ attr_copy.attr("__doc__") += "\n\n";`
	`477`	`+ attr_copy.attr("__doc__") += doc;`
	`478`	`+ }`
	`479`	`+ else`
	`480`	`+ attr_copy.attr("__doc__") = doc;`
`476`	`481`	`}`
`477`	`482`	`}`
`478`	`483`
Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,8 @@ BOOST_PYTHON_MODULE(docstring_ext)`
`47`	`47`	`)`
`48`	`48`	`.def("value", &X::value,`
`49`	`49`	`"gets the value of the object")`
	`50`	`+ .def( "value", &X::value,`
	`51`	`+ "also gets the value of the object")`
`50`	`52`	`;`
`51`	`53`
`52`	`54`	`def("create", create, return_value_policy<manage_new_object>(),`