Add news fragment

lsst · Sep 14, 2023 · 2a0ccc3 · 2a0ccc3
1 parent 8a3a9db
commit 2a0ccc3
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/doc/changes/DM-22287.bugfix.rst b/doc/changes/DM-22287.bugfix.rst
@@ -0,0 +1 @@
+Fixed ``inheritDoc`` to insert newlines between the parent and child docstrings and also correct for indentation differences.
diff --git a/python/lsst/utils/inheritDoc.py b/python/lsst/utils/inheritDoc.py
@@ -61,8 +61,9 @@ def tmpDecorator(method: type) -> Callable:
         parentText = inspect.cleandoc(getattr(klass, methodName).__doc__ or "")
 
         if parentText and appendText:
-            # Strip so we can ensure that we can insert new lines properly.
-            method.__doc__ = parentText.rstrip() + "\n\n" + appendText
+            # cleandoc() strips leading and trailing space so it is safe
+            # to add new lines.
+            method.__doc__ = parentText + "\n\n" + appendText
         elif parentText:
             method.__doc__ = parentText
         else: