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

fix the expected parameters section to match the current status

Browse Source
This commit is contained in:
Keewis 2020-05-22 21:37:06 +02:00
parent fc70205fb4
commit 2882c3465a
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
tests/test_ext_napoleon_docstring.py
View File

@ -2106,15 +2106,15 @@ definition_after_normal_text : int
""") """)
expected = textwrap.dedent("""\ expected = textwrap.dedent("""\
:param param1: the data to work on :param param1: the data to work on
:type param1: :obj:`DataFrame` :type param1: DataFrame
:param param2: a parameter with different types :param param2: a parameter with different types
:type param2: :obj:`int` or :obj:`float` or :obj:`None` :type param2: :obj:`int` or :obj:`float` or :obj:`None`
:param param3: a optional mapping :param param3: a optional mapping
:type param3: :obj:`dict-like`, optional :type param3: :term:`dict-like <mapping>`, :noref:`optional`
:param param4: a optional parameter with different types :param param4: a optional parameter with different types
:type param4: :obj:`int` or :obj:`float` or :obj:`None`, optional :type param4: :obj:`int` or :obj:`float` or :obj:`None`, :noref:`optional`
:param param5: a optional parameter with fixed values :param param5: a optional parameter with fixed values
:type param5: {"F", "C", "N"}, optional :type param5: :noref:`{"F", "C", "N"}`, :noref:`optional`
""") """)
config = Config(napoleon_use_param=True, napoleon_use_rtype=True) config = Config(napoleon_use_param=True, napoleon_use_rtype=True)
actual = str(NumpyDocstring(docstring, config)) actual = str(NumpyDocstring(docstring, config))