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

use textwrap for a normal indentation depth

Browse Source
This commit is contained in:
Keewis 2020-05-17 22:50:32 +02:00
parent a7bbedfbb7
commit b1f43d2fff
1 changed files with 27 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
tests/test_ext_napoleon_docstring.py
View File

@ -1977,32 +1977,33 @@ definition_after_normal_text : int
self.assertEqual(expected, actual)
def test_parameter_types(self):
docstring = """\
Parameters
----------
param1 : DataFrame
the data to work on
param2 : int or float or None
a parameter with different types
param3 : dict-like, optional
a optional mapping
param4 : int or float or None, optional
a optional parameter with different types
param5 : {"F", "C", "N"}, optional
a optional parameter with fixed values
"""
expected = """\
:param param1: the data to work on
:type param1: :obj:`DataFrame`
:param param2: a parameter with different types
:type param2: :obj:`int` or :obj:`float` or :obj:`None`
:param param3: a optional mapping
:type param3: :obj:`dict-like`, optional
:param param4: a optional parameter with different types
:type param4: :obj:`int` or :obj:`float` or :obj:`None`, optional
:param param5: a optional parameter with fixed values
:type param5: {"F", "C", "N"}, optional
"""
import textwrap
docstring = textwrap.dedent("""\
Parameters
----------
param1 : DataFrame
the data to work on
param2 : int or float or None
a parameter with different types
param3 : dict-like, optional
a optional mapping
param4 : int or float or None, optional
a optional parameter with different types
param5 : {"F", "C", "N"}, optional
a optional parameter with fixed values
""")
expected = textwrap.dedent("""\
:param param1: the data to work on
:type param1: :obj:`DataFrame`
:param param2: a parameter with different types
:type param2: :obj:`int` or :obj:`float` or :obj:`None`
:param param3: a optional mapping
:type param3: :obj:`dict-like`, optional
:param param4: a optional parameter with different types
:type param4: :obj:`int` or :obj:`float` or :obj:`None`, optional
:param param5: a optional parameter with fixed values
:type param5: {"F", "C", "N"}, optional
""")
config = Config(napoleon_use_param=True, napoleon_use_rtype=True)
actual = str(NumpyDocstring(docstring, config))
self.assertEqual(expected, actual)