Use StringList for append_docstring_from_another to keep output consistent.

Author: domdfcoding

domdf_python_tools/doctools.py

@@ -34,6 +34,7 @@
 from typing import Any, Callable, Dict, Optional, Sequence, Type, TypeVar, Union
 
 # this package
+from domdf_python_tools.stringlist import StringList
 from domdf_python_tools.typing import MethodDescriptorType, MethodWrapperType, WrapperDescriptorType
 
 __all__ = [
@@ -102,13 +103,16 @@ def append_doctring_from_another(target: Union[Type, Callable], original: Union[
 	original_doc = original.__doc__
 
 	if isinstance(original_doc, str) and isinstance(target_doc, str):
-		deindented_target_doc = cleandoc(target_doc)
-		deindented_original_doc = cleandoc(original_doc)
-
-		target.__doc__ = deindented_target_doc + "\n" + deindented_original_doc
+		docstring = StringList(cleandoc(target_doc))
+		docstring.blankline(ensure_single=True)
+		docstring.append(cleandoc(original_doc))
+		docstring.blankline(ensure_single=True)
+		target.__doc__ = str(docstring)
 
 	elif not isinstance(target_doc, str) and isinstance(original_doc, str):
-		target.__doc__ = cleandoc(original_doc)
+		docstring = StringList(cleandoc(original_doc))
+		docstring.blankline(ensure_single=True)
+		target.__doc__ = str(docstring)
 
 
 def make_sphinx_links(input_string: str, builtins_list: Optional[Sequence[str]] = None) -> str:

tests/test_doctools.py

@@ -208,14 +208,14 @@ def test_decorators():
 
 	# set_opening_hours and ceil should have extra text at the beginning
 	assert SpamCafe.set_opening_hours.__doc__.startswith("I will not buy this record, it is scratched.")
-	assert (doctools.deindent_string(SpamCafe.set_opening_hours.__doc__) + "\n").endswith(
-			doctools.deindent_string(Cafe.set_opening_hours.__doc__)
-			)
+	assert (doctools.deindent_string(SpamCafe.set_opening_hours.__doc__
+										)).endswith(doctools.deindent_string(Cafe.set_opening_hours.__doc__))
 	# Dedented both strings to be sure of equivalence
 	assert SpamCafe.ceil.__doc__.startswith(
 			"I don't know why the cafe has a ceil function, but we'd better document it properly.",
 			)
-	assert doctools.deindent_string(SpamCafe.ceil.__doc__).endswith(doctools.deindent_string(math.ceil.__doc__))
+	assert doctools.deindent_string(SpamCafe.ceil.__doc__
+									).endswith(doctools.deindent_string(math.ceil.__doc__) + "\n")
 	# Dedented both strings to be sure of equivalence
 
 	# Functions
@@ -225,9 +225,8 @@ def test_decorators():
 	assert partially_documented_function.__doc__.startswith(
 			"This function works like ``documented_function`` except it returns the result telepathically.",
 			)
-	assert (doctools.deindent_string(partially_documented_function.__doc__) + "\n").endswith(
-			doctools.deindent_string(documented_function.__doc__)
-			)
+	assert (doctools.deindent_string(partially_documented_function.__doc__
+										)).endswith(doctools.deindent_string(documented_function.__doc__))
 	# Dedented both strings to be sure of equivalence
 	assert DummyClass.function_in_class_with_same_args.__doc__ == documented_function.__doc__
 	assert DummyClass.function_in_class_with_same_args.__name__ == "function_in_class_with_same_args"
@@ -261,10 +260,10 @@ def funD():
 	assert funC.__doc__ == "World"
 
 	doctools.append_doctring_from_another(funB, funC)
-	assert funB.__doc__ == "Hello\nWorld"
+	assert funB.__doc__ == "Hello\n\nWorld\n"
 
 	doctools.append_doctring_from_another(funD, funB)
-	assert funD.__doc__ == "Hello\nWorld"
+	assert funD.__doc__ == "Hello\n\nWorld\n"
 
 
 def test_still_callable():