From dc8c7ac9f8efd9b984c406a6bea410333a7be404 Mon Sep 17 00:00:00 2001 From: Keewis Date: Fri, 29 May 2020 21:30:14 +0200 Subject: [PATCH] update the integration test --- tests/test_ext_napoleon_docstring.py | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/tests/test_ext_napoleon_docstring.py b/tests/test_ext_napoleon_docstring.py index e1c296e79..49479fa59 100644 --- a/tests/test_ext_napoleon_docstring.py +++ b/tests/test_ext_napoleon_docstring.py @@ -2068,13 +2068,13 @@ definition_after_normal_text : int converted_types = ( ":obj:`str`", ":obj:`int` or :obj:`float` or :obj:`None`", - ':noref:`{"F", "C", "N"}`', - ":noref:`{'F', 'C', 'N'}`", + '``{"F", "C", "N"}``', + "``{'F', 'C', 'N'}``", ) converted_modifiers = ( "", - ":noref:`optional`", - ":noref:`default`: :obj:`None`", + "*optional*", + "*default*: :obj:`None`", ) converted = tuple( ", ".join([converted_type, converted_modifier]) @@ -2114,13 +2114,20 @@ definition_after_normal_text : int :param param2: a parameter with different types :type param2: :obj:`int` or :obj:`float` or :obj:`None` :param param3: a optional mapping - :type param3: :term:`dict-like `, :noref:`optional` + :type param3: :term:`dict-like `, *optional* :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 - :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 `", + } + config = Config( + napoleon_use_param=True, + napoleon_use_rtype=True, + napoleon_type_aliases=translations, + ) actual = str(NumpyDocstring(docstring, config)) self.assertEqual(expected, actual)