Fix in sphinx directive: an empty line must separate the original doc…

…string and the directive.

deprecated/sphinx.py

@@ -39,7 +39,7 @@ def __call__(self, wrapped):
  for line in reason.splitlines()).strip()
  docstring = textwrap.dedent(wrapped.__doc__ or "")
  if docstring:
- docstring += "\n"
+ docstring += "\n\n"
  if self.version:
  docstring += ".. {directive}:: {version}\n".format(directive=self.directive, version=self.version)
  else:

tests/test_sphinx.py

@@ -1,6 +1,7 @@
 # coding: utf-8
 from __future__ import print_function
 
+import re
 import sys
 import textwrap
 import warnings
@@ -46,9 +47,9 @@ def directive(request):
  ('A good reason',
  None,
  textwrap.dedent("""\
- .. {directive}::
- {reason}
- """)),
+  .. {directive}::
+  {reason}
+  """)),
 ])
 def test_has_sphinx_docstring(docstring, directive, reason, version, expected):
  # The function:
@@ -69,6 +70,12 @@ 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:
+ assert re.search("\n[ ]*\n$", current, flags=re.DOTALL)
+
+
 
 class MyDeprecationWarning(DeprecationWarning):
  pass