Correct regex in sphinx.py: An empty line must separate the original …

…docstring and the directive.
laurent-laporte-pro · Jan 16, 2021 · 1c0abcd · 1c0abcd
1 parent ab2c1bf
commit 1c0abcd
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/deprecated/sphinx.py b/deprecated/sphinx.py
@@ -117,7 +117,8 @@ def __call__(self, wrapped):
         # -- get the docstring, normalize the trailing newlines
         docstring = textwrap.dedent(wrapped.__doc__ or "")
         if docstring:
-            docstring = re.sub(r"\n*$", "\n\n", docstring, flags=re.DOTALL)
+            # An empty line must separate the original docstring and the directive.
+            docstring = re.sub(r"\n+$", "", docstring, flags=re.DOTALL) + "\n\n"
 
         # -- append the directive division to the docstring
         docstring += "".join("{}\n".format(line) for line in div_lines)