diff --git a/sphinx_icontract/__init__.py b/sphinx_icontract/__init__.py index 2814eae..447ed0f 100644 --- a/sphinx_icontract/__init__.py +++ b/sphinx_icontract/__init__.py @@ -361,7 +361,7 @@ def _format_contract(contract: icontract._Contract) -> Lines: doc = None if doc is not None: - result = condition_lines + Lines(["({})".format(doc)]) + result = condition_lines + Lines(["", "({})".format(doc)]) else: result = condition_lines diff --git a/tests/test_sphinx_icontract.py b/tests/test_sphinx_icontract.py index 7a0197e..ac20f66 100644 --- a/tests/test_sphinx_icontract.py +++ b/tests/test_sphinx_icontract.py @@ -263,6 +263,7 @@ def resolve_initial_paths(initial_paths: List[pathlib.Path]) -> List[pathlib.Pat # yapf: disable ':ensures:', ' * :code:`all(pth in result for pth in initial_paths if pth.is_file())`', + '', ' (Initial files also in result)' # yapf: enable ], @@ -395,9 +396,11 @@ def some_func(x: int) -> int: # yapf: disable ':requires:', ' * :code:`x > 0`', + '', ' (some precondition)', ':ensures:', ' * :code:`result >= x`', + '', ' (some postcondition)' # yapf: enable ], @@ -474,6 +477,7 @@ def some_getter(self) -> int: # yapf: disable ':establishes:', ' * :code:`self.some_getter() > 0`', + '', ' (some invariant)' # yapf: enable ], @@ -637,6 +641,7 @@ def some_func(x: int) -> None: [ ':requires:', ' * :code:`x > 0`', + '', ' (x positive; raise :py:class:`ValueError`)' ], lines) @@ -656,6 +661,7 @@ def some_func(x: int) -> None: [ ':requires:', ' * :code:`x > 0`', + '', ' (Raise :py:class:`ValueError`)' ], lines) @@ -673,6 +679,7 @@ def some_func(x: int) -> None: [ ':requires:', ' * :code:`x > 0`', + '', ' (x positive; raise :py:class:`ValueError`)' ], lines) @@ -693,6 +700,7 @@ def some_func(x: int) -> None: [ ':requires:', ' * :py:func:`must_be_positive`', + '', ' (x positive; raise :py:class:`ValueError`)' ], lines) @@ -714,6 +722,7 @@ def some_func(x: int) -> None: [ ':requires:', ' * :code:`x > 0`', + '', ' (x positive; raise :py:class:`SomeClass.SomeError`)' ], lines) @@ -732,6 +741,7 @@ def some_func(x: int) -> None: [ ':requires:', ' * :code:`x > 0`', + '', ' (x must be positive; raise :py:class:`ValueError`)' ], lines) @@ -749,6 +759,7 @@ def some_func(x: int) -> None: [ ':requires:', ' * :code:`x > 0`', + '', ' (Raise :py:class:`ValueError`)' ], lines) @@ -769,6 +780,7 @@ def some_func(x: int) -> None: [ ':requires:', ' * :py:func:`must_be_positive`', + '', ' (Raise :py:class:`ValueError`)' ], lines) @@ -787,6 +799,7 @@ def some_func(x: int) -> None: [ ':requires:', ' * :code:`x > 0`', + '', ' (x must be positive; raise :py:class:`ValueError`)' ], lines)