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

update the integration test

Browse Source
This commit is contained in:
Keewis 2020-05-29 21:30:14 +02:00
parent 20e36007fe
commit dc8c7ac9f8
1 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
tests/test_ext_napoleon_docstring.py
View File

@ -2068,13 +2068,13 @@ definition_after_normal_text : int
converted_types = ( converted_types = (
":obj:`str`", ":obj:`str`",
":obj:`int` or :obj:`float` or :obj:`None`", ":obj:`int` or :obj:`float` or :obj:`None`",
':noref:`{"F", "C", "N"}`', '``{"F", "C", "N"}``',
":noref:`{'F', 'C', 'N'}`", "``{'F', 'C', 'N'}``",
) )
converted_modifiers = ( converted_modifiers = (
"", "",
":noref:`optional`", "*optional*",
":noref:`default`: :obj:`None`", "*default*: :obj:`None`",
) )
converted = tuple( converted = tuple(
", ".join([converted_type, converted_modifier]) ", ".join([converted_type, converted_modifier])
@ -2114,13 +2114,20 @@ definition_after_normal_text : int
: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: :term:`dict-like <mapping>`, :noref:`optional` :type param3: :term:`dict-like <mapping>`, *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`, :noref:`optional` :type param4: :obj:`int` or :obj:`float` or :obj:`None`, *optional*
:param param5: a optional parameter with fixed values :param param5: a optional parameter with fixed values
:type param5: :noref:`{"F", "C", "N"}`, :noref:`optional` :type param5: ``{"F", "C", "N"}``, *optional*
""") """)
config = Config(napoleon_use_param=True, napoleon_use_rtype=True) translations = {
"dict-like": ":term:`dict-like <mapping>`",
}
config = Config(
napoleon_use_param=True,
napoleon_use_rtype=True,
napoleon_type_aliases=translations,
)
actual = str(NumpyDocstring(docstring, config)) actual = str(NumpyDocstring(docstring, config))
self.assertEqual(expected, actual) self.assertEqual(expected, actual)