Avoid "Explicit markup ends without a blank line" when the decorated …

…function has no docstring.
tantale · Feb 4, 2021 · f1ad5b4 · f1ad5b4
1 parent a02525b
commit f1ad5b4
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 25 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -23,6 +23,12 @@ v1.2.12 (unreleased)
 
 Bug fix release
 
+Fix
+---
+
+- Avoid "Explicit markup ends without a blank line" when the decorated function has no docstring.
+
+
 Other
 -----
 

diff --git a/deprecated/sphinx.py b/deprecated/sphinx.py
@@ -119,6 +119,9 @@ def __call__(self, wrapped):
         if docstring:
             # An empty line must separate the original docstring and the directive.
             docstring = re.sub(r"\n+$", "", docstring, flags=re.DOTALL) + "\n\n"
+        else:
+            # Avoid "Explicit markup ends without a blank line" when the decorated function has no docstring
+            docstring = "\n"
 
         # -- append the directive division to the docstring
         docstring += "".join("{}\n".format(line) for line in div_lines)

diff --git a/tests/test_sphinx.py b/tests/test_sphinx.py
@@ -24,7 +24,7 @@
         :return: sum = *x* + *y*
         """,
     ],
-    ids=["no_docstring", "short_docstring", "long_docstring"]
+    ids=["no_docstring", "short_docstring", "long_docstring"],
 )
 def docstring(request):
     return request.param
@@ -44,32 +44,32 @@ def directive(request):
             '1.2.0',
             textwrap.dedent(
                 """\
-                     .. {directive}:: {version}
-                        {reason}
-                     """
+                .. {directive}:: {version}
+                   {reason}
+                """
             ),
         ),
         (
             None,
             '1.2.0',
             textwrap.dedent(
                 """\
-                     .. {directive}:: {version}
-                     """
+                .. {directive}:: {version}
+                """
             ),
         ),
         (
             'A good reason',
             None,
             textwrap.dedent(
                 """\
-                     .. {directive}::
-                        {reason}
-                     """
+                .. {directive}::
+                   {reason}
+                """
             ),
         ),
     ],
-    ids=["reason&version", "version", "reason"]
+    ids=["reason&version", "version", "reason"],
 )
 def test_has_sphinx_docstring(docstring, directive, reason, version, expected):
     # The function:
@@ -90,10 +90,13 @@ def foo(x, y):
     current = textwrap.dedent(foo.__doc__)
     assert current.endswith(expected)
 
-    # An empty line must separate the original docstring and the directive.
     current = current.replace(expected, '')
-    if current:
+    if docstring:
+        # An empty line must separate the original docstring and the directive.
         assert re.search("\n[ ]*\n$", current, flags=re.DOTALL)
+    else:
+        # Avoid "Explicit markup ends without a blank line" when the decorated function has no docstring
+        assert current == "\n"
 
     with warnings.catch_warnings(record=True) as warns:
         foo(1, 2)
@@ -118,32 +121,32 @@ def foo(x, y):
             '1.2.0',
             textwrap.dedent(
                 """\
-                     .. {directive}:: {version}
-                        {reason}
-                     """
+                .. {directive}:: {version}
+                   {reason}
+                """
             ),
         ),
         (
             None,
             '1.2.0',
             textwrap.dedent(
                 """\
-                     .. {directive}:: {version}
-                     """
+                .. {directive}:: {version}
+                """
             ),
         ),
         (
             'A good reason',
             None,
             textwrap.dedent(
                 """\
-                     .. {directive}::
-                        {reason}
-                     """
+                .. {directive}::
+                   {reason}
+                """
             ),
         ),
     ],
-    ids=["reason&version", "version", "reason"]
+    ids=["reason&version", "version", "reason"],
 )
 def test_cls_has_sphinx_docstring(docstring, directive, reason, version, expected):
     # The class:
@@ -164,10 +167,13 @@ class Foo(object):
     current = textwrap.dedent(Foo.__doc__)
     assert current.endswith(expected)
 
-    # An empty line must separate the original docstring and the directive.
     current = current.replace(expected, '')
-    if current:
+    if docstring:
+        # An empty line must separate the original docstring and the directive.
         assert re.search("\n[ ]*\n$", current, flags=re.DOTALL)
+    else:
+        # Avoid "Explicit markup ends without a blank line" when the decorated function has no docstring
+        assert current == "\n"
 
     with warnings.catch_warnings(record=True) as warns:
         Foo()

diff --git a/tests/test_sphinx_adapter.py b/tests/test_sphinx_adapter.py
@@ -86,7 +86,7 @@ def foo():
 
     wrapped = adapter.__call__(foo)
     expected = textwrap.dedent(
-        """\
+        """
         .. {directive}:: 1.2.3
            foo has changed in this version
 
@@ -117,7 +117,7 @@ def foo():
     foo = decorator(foo)
 
     expected = textwrap.dedent(
-        """\
+        """
         .. {directive}:: 1.2.3
            bar bar bar bar bar bar bar bar bar bar bar
            bar bar bar bar bar bar bar bar bar bar bar