IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Related to #1927: [Napoleon] always start description on same line as type in Raises section

Browse Source
This commit is contained in:
Rob Ruana
2015-06-11 12:50:05 -07:00
parent bfdbee0d04
commit 4670c87be2
2 changed files with 112 additions and 134 deletions
Download Patch File Download Diff File Expand all files Collapse all files

206
tests/test_ext_napoleon_docstring.py
View File

@@ -58,19 +58,15 @@ Sample namedtuple subclass
.. attribute:: attr1
*Arbitrary type* --
Quick description of attr1
*Arbitrary type* -- Quick description of attr1
.. attribute:: attr2
*Another arbitrary type* --
Quick description of attr2
*Another arbitrary type* -- Quick description of attr2
.. attribute:: attr3
*Type*
""""""
Adds a newline after the type
*Type* -- Adds a newline after the type
"""
self.assertEqual(expected, actual)
@@ -103,9 +99,9 @@ class GoogleDocstringTest(BaseDocstringTest):
"""
Single line summary
:Parameters: **arg1** (*str*) --
Extended
description of arg1"""
:Parameters: **arg1** (*str*) -- Extended
description of arg1
"""
), (
"""
Single line summary
@@ -124,19 +120,16 @@ class GoogleDocstringTest(BaseDocstringTest):
"""
Single line summary
:Parameters: * **arg1** (*str*) --
Extended
:Parameters: * **arg1** (*str*) -- Extended
description of arg1
* **arg2** (*int*) --
Extended
* **arg2** (*int*) -- Extended
description of arg2
:Keyword Arguments: * **kwarg1** (*str*) --
Extended
:Keyword Arguments: * **kwarg1** (*str*) -- Extended
description of kwarg1
* **kwarg2** (*int*) --
Extended
description of kwarg2"""
* **kwarg2** (*int*) -- Extended
description of kwarg2
"""
), (
"""
Single line summary
@@ -155,19 +148,16 @@ class GoogleDocstringTest(BaseDocstringTest):
"""
Single line summary
:Parameters: * **arg1** (*str*) --
Extended
:Parameters: * **arg1** (*str*) -- Extended
description of arg1
* **arg2** (*int*) --
Extended
* **arg2** (*int*) -- Extended
description of arg2
:Keyword Arguments: * **kwarg1** (*str*) --
Extended
:Keyword Arguments: * **kwarg1** (*str*) -- Extended
description of kwarg1
* **kwarg2** (*int*) --
Extended
description of kwarg2"""
* **kwarg2** (*int*) -- Extended
description of kwarg2
"""
), (
"""
Single line summary
@@ -179,9 +169,9 @@ class GoogleDocstringTest(BaseDocstringTest):
"""
Single line summary
:returns: *str* --
Extended
description of return value"""
:returns: *str* -- Extended
description of return value
"""
), (
"""
Single line summary
@@ -193,9 +183,9 @@ class GoogleDocstringTest(BaseDocstringTest):
"""
Single line summary
:returns: *str* --
Extended
description of return value"""
:returns: *str* -- Extended
description of return value
"""
), (
"""
Single line summary
@@ -208,7 +198,8 @@ class GoogleDocstringTest(BaseDocstringTest):
Single line summary
:returns: Extended
description of return value"""
description of return value
"""
), (
"""
Single line summary
@@ -222,13 +213,11 @@ class GoogleDocstringTest(BaseDocstringTest):
"""
Single line summary
:Parameters: * **arg1** (*str*) --
Extended
:Parameters: * **arg1** (*str*) -- Extended
description of arg1
* **\\*args** --
Variable length argument list.
* **\\*\\*kwargs** --
Arbitrary keyword arguments."""
* **\\*args** -- Variable length argument list.
* **\\*\\*kwargs** -- Arbitrary keyword arguments.
"""
), (
"""
Single line summary
@@ -240,9 +229,9 @@ class GoogleDocstringTest(BaseDocstringTest):
"""
Single line summary
:Yields: *str* --
Extended
description of yielded value"""
:Yields: *str* -- Extended
description of yielded value
"""
), (
"""
Single line summary
@@ -255,7 +244,8 @@ class GoogleDocstringTest(BaseDocstringTest):
Single line summary
:Yields: Extended
description of yielded value"""
description of yielded value
"""
)]
def test_docstrings(self):
@@ -312,8 +302,7 @@ Attributes:
expected = """\
.. attribute:: in_attr
:class:`numpy.ndarray` --
super-dooper attribute
:class:`numpy.ndarray` -- super-dooper attribute
"""
self.assertEqual(expected, actual)
@@ -326,8 +315,7 @@ Attributes:
expected = """\
.. attribute:: in_attr
*numpy.ndarray* --
super-dooper attribute
*numpy.ndarray* -- super-dooper attribute
"""
self.assertEqual(expected, actual)
@@ -394,12 +382,8 @@ Raises:
""", """
Example Function
:raises: * :exc:`RuntimeError`
A setting wasn't specified, or was invalid.
* :exc:`ValueError`
Something something value error.
:raises: * :exc:`RuntimeError` -- A setting wasn't specified, or was invalid.
* :exc:`ValueError` -- Something something value error.
"""),
################################
("""
@@ -435,8 +419,7 @@ Raises:
""", """
Example Function
:raises: *Invalid Dimensions Error* --
With description
:raises: *Invalid Dimensions Error* -- With description
"""),
################################
("""
@@ -448,8 +431,7 @@ Raises:
""", """
Example Function
:raises: :exc:`InvalidDimensionsError` --
If the dimensions couldn't be parsed.
:raises: :exc:`InvalidDimensionsError` -- If the dimensions couldn't be parsed.
"""),
################################
("""
@@ -461,8 +443,7 @@ Raises:
""", """
Example Function
:raises: *Invalid Dimensions Error* --
If the dimensions couldn't be parsed.
:raises: *Invalid Dimensions Error* -- If the dimensions couldn't be parsed.
"""),
################################
("""
@@ -498,8 +479,8 @@ Raises:
""", """
Example Function
:raises: :class:`exc.InvalidDimensionsError` --
If the dimensions couldn't be parsed.
:raises: :class:`exc.InvalidDimensionsError` -- If the dimensions couldn't """
"""be parsed.
"""),
################################
("""
@@ -512,8 +493,8 @@ Raises:
""", """
Example Function
:raises: :class:`exc.InvalidDimensionsError` --
If the dimensions couldn't be parsed,
:raises: :class:`exc.InvalidDimensionsError` -- If the dimensions couldn't """
"""be parsed,
then a :class:`exc.InvalidDimensionsError` will be raised.
"""),
################################
@@ -527,10 +508,9 @@ Raises:
""", """
Example Function
:raises: * :class:`exc.InvalidDimensionsError` --
If the dimensions couldn't be parsed.
* :class:`exc.InvalidArgumentsError` --
If the arguments are invalid.
:raises: * :class:`exc.InvalidDimensionsError` -- If the dimensions """
"""couldn't be parsed.
* :class:`exc.InvalidArgumentsError` -- If the arguments are invalid.
"""),
################################
("""
@@ -611,9 +591,9 @@ class NumpyDocstringTest(BaseDocstringTest):
"""
Single line summary
:Parameters: **arg1** (*str*) --
Extended
description of arg1"""
:Parameters: **arg1** (*str*) -- Extended
description of arg1
"""
), (
"""
Single line summary
@@ -639,19 +619,16 @@ class NumpyDocstringTest(BaseDocstringTest):
"""
Single line summary
:Parameters: * **arg1** (*str*) --
Extended
:Parameters: * **arg1** (*str*) -- Extended
description of arg1
* **arg2** (*int*) --
Extended
* **arg2** (*int*) -- Extended
description of arg2
:Keyword Arguments: * **kwarg1** (*str*) --
Extended
:Keyword Arguments: * **kwarg1** (*str*) -- Extended
description of kwarg1
* **kwarg2** (*int*) --
Extended
description of kwarg2"""
* **kwarg2** (*int*) -- Extended
description of kwarg2
"""
), (
"""
Single line summary
@@ -665,9 +642,9 @@ class NumpyDocstringTest(BaseDocstringTest):
"""
Single line summary
:returns: *str* --
Extended
description of return value"""
:returns: *str* -- Extended
description of return value
"""
), (
"""
Single line summary
@@ -681,9 +658,9 @@ class NumpyDocstringTest(BaseDocstringTest):
"""
Single line summary
:returns: *str* --
Extended
description of return value"""
:returns: *str* -- Extended
description of return value
"""
), (
"""
Single line summary
@@ -700,12 +677,10 @@ class NumpyDocstringTest(BaseDocstringTest):
"""
Single line summary
:Parameters: * **arg1** (*str*) --
Extended description of arg1
* ***args** --
Variable length argument list.
* ****kwargs** --
Arbitrary keyword arguments."""
:Parameters: * **arg1** (*str*) -- Extended description of arg1
* ***args** -- Variable length argument list.
* ****kwargs** -- Arbitrary keyword arguments.
"""
), (
"""
Single line summary
@@ -719,9 +694,9 @@ class NumpyDocstringTest(BaseDocstringTest):
"""
Single line summary
:Yields: *str* --
Extended
description of yielded value"""
:Yields: *str* -- Extended
description of yielded value
"""
), (
"""
Single line summary
@@ -735,9 +710,9 @@ class NumpyDocstringTest(BaseDocstringTest):
"""
Single line summary
:Yields: *str* --
Extended
description of yielded value"""
:Yields: *str* -- Extended
description of yielded value
"""
)]
def test_docstrings(self):
@@ -903,12 +878,8 @@ Raises
""", """
Example Function
:raises: * :exc:`RuntimeError`
A setting wasn't specified, or was invalid.
* :exc:`ValueError`
Something something value error.
:raises: * :exc:`RuntimeError` -- A setting wasn't specified, or was invalid.
* :exc:`ValueError` -- Something something value error.
"""),
################################
("""
@@ -948,8 +919,7 @@ Invalid Dimensions Error
""", """
Example Function
:raises: *Invalid Dimensions Error* --
With description
:raises: *Invalid Dimensions Error* -- With description
"""),
################################
("""
@@ -963,8 +933,7 @@ InvalidDimensionsError
""", """
Example Function
:raises: :exc:`InvalidDimensionsError` --
If the dimensions couldn't be parsed.
:raises: :exc:`InvalidDimensionsError` -- If the dimensions couldn't be parsed.
"""),
################################
("""
@@ -978,8 +947,7 @@ Invalid Dimensions Error
""", """
Example Function
:raises: *Invalid Dimensions Error* --
If the dimensions couldn't be parsed.
:raises: *Invalid Dimensions Error* -- If the dimensions couldn't be parsed.
"""),
################################
("""
@@ -1019,8 +987,8 @@ Raises
""", """
Example Function
:raises: :class:`exc.InvalidDimensionsError` --
If the dimensions couldn't be parsed.
:raises: :class:`exc.InvalidDimensionsError` -- If the dimensions couldn't """
"""be parsed.
"""),
################################
("""
@@ -1035,8 +1003,8 @@ Raises
""", """
Example Function
:raises: :class:`exc.InvalidDimensionsError` --
If the dimensions couldn't be parsed,
:raises: :class:`exc.InvalidDimensionsError` -- If the dimensions couldn't """
"""be parsed,
then a :class:`exc.InvalidDimensionsError` will be raised.
"""),
################################
@@ -1053,10 +1021,10 @@ Raises
""", """
Example Function
:raises: * :class:`exc.InvalidDimensionsError` --
If the dimensions couldn't be parsed.
* :class:`exc.InvalidArgumentsError` --
If the arguments are invalid.
:raises: * :class:`exc.InvalidDimensionsError` -- If the dimensions """
"""couldn't be parsed.
* :class:`exc.InvalidArgumentsError` -- If the arguments """
"""are invalid.
"""),
################################
("""