diff options
| author | Jean-François B <2589111+jfbu@users.noreply.github.com> | 2022-08-06 18:31:14 +0200 |
|---|---|---|
| committer | Jean-François B <2589111+jfbu@users.noreply.github.com> | 2022-08-06 18:31:14 +0200 |
| commit | 5c82449eca73ef448eb7fdfbcc061cb91d70c18c (patch) | |
| tree | c4a8394dd9105ba73e2df12c3c5e26cbae501d54 /tests/test_ext_napoleon_docstring.py | |
| parent | 6f530ca3ea305a4c4e077a237fc7196e959a4bb4 (diff) | |
| parent | 59056aa7816ebae81aa6842290aa7a6ece14d1bd (diff) | |
| download | sphinx-git-5c82449eca73ef448eb7fdfbcc061cb91d70c18c.tar.gz | |
Merge branch '5.x'
Diffstat (limited to 'tests/test_ext_napoleon_docstring.py')
| -rw-r--r-- | tests/test_ext_napoleon_docstring.py | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/tests/test_ext_napoleon_docstring.py b/tests/test_ext_napoleon_docstring.py index 6db897932..c2704ebce 100644 --- a/tests/test_ext_napoleon_docstring.py +++ b/tests/test_ext_napoleon_docstring.py @@ -356,6 +356,41 @@ class GoogleDocstringTest(BaseDocstringTest): :Yields: Extended description of yielded value """ + ), ( + """ + Single line summary + + Args: + + arg1 (list of str): Extended + description of arg1. + arg2 (tuple of int): Extended + description of arg2. + arg3 (tuple of list of float): Extended + description of arg3. + arg4 (int, float, or list of bool): Extended + description of arg4. + arg5 (list of int, float, or bool): Extended + description of arg5. + arg6 (list of int or float): Extended + description of arg6. + """, + """ + Single line summary + + :Parameters: * **arg1** (*list of str*) -- Extended + description of arg1. + * **arg2** (*tuple of int*) -- Extended + description of arg2. + * **arg3** (*tuple of list of float*) -- Extended + description of arg3. + * **arg4** (*int, float, or list of bool*) -- Extended + description of arg4. + * **arg5** (*list of int, float, or bool*) -- Extended + description of arg5. + * **arg6** (*list of int or float*) -- Extended + description of arg6. + """ )] def test_sphinx_admonitions(self): @@ -2367,6 +2402,8 @@ definition_after_normal_text : int "defaultdict", "int, float, or complex", "int or float or None, optional", + "list of list of int or float, optional", + "tuple of list of str, float, or int", '{"F", "C", "N"}', "{'F', 'C', 'N'}, default: 'F'", "{'F', 'C', 'N or C'}, default 'F'", @@ -2383,6 +2420,8 @@ definition_after_normal_text : int ["defaultdict"], ["int", ", ", "float", ", or ", "complex"], ["int", " or ", "float", " or ", "None", ", ", "optional"], + ["list", " of ", "list", " of ", "int", " or ", "float", ", ", "optional"], + ["tuple", " of ", "list", " of ", "str", ", ", "float", ", or ", "int"], ["{", '"F"', ", ", '"C"', ", ", '"N"', "}"], ["{", "'F'", ", ", "'C'", ", ", "'N'", "}", ", ", "default", ": ", "'F'"], ["{", "'F'", ", ", "'C'", ", ", "'N or C'", "}", ", ", "default", " ", "'F'"], @@ -2443,6 +2482,7 @@ definition_after_normal_text : int "optional", "str, optional", "int or float or None, default: None", + "list of tuple of str, optional", "int, default None", '{"F", "C", "N"}', "{'F', 'C', 'N'}, default: 'N'", @@ -2455,6 +2495,7 @@ definition_after_normal_text : int "*optional*", ":class:`str`, *optional*", ":class:`int` or :class:`float` or :obj:`None`, *default*: :obj:`None`", + ":class:`list` of :class:`tuple` of :class:`str`, *optional*", ":class:`int`, *default* :obj:`None`", '``{"F", "C", "N"}``', "``{'F', 'C', 'N'}``, *default*: ``'N'``", @@ -2486,6 +2527,8 @@ definition_after_normal_text : int a optional mapping param8 : ... or Ellipsis ellipsis + param9 : tuple of list of int + a parameter with tuple of list of int """) expected = dedent("""\ :param param1: the data to work on @@ -2504,6 +2547,8 @@ definition_after_normal_text : int :type param7: :term:`mapping` of :term:`hashable` to :class:`str`, *optional* :param param8: ellipsis :type param8: :obj:`... <Ellipsis>` or :obj:`Ellipsis` + :param param9: a parameter with tuple of list of int + :type param9: :class:`tuple` of :class:`list` of :class:`int` """) translations = { "dict-like": ":term:`dict-like <mapping>`", |