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

add more delimiters so describing mappings becomes possible

Browse Source
This commit is contained in:
Keewis
2020-07-29 22:29:03 +02:00
parent 05bf00bd4c
commit e39c1a8d6a
2 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
tests/test_ext_napoleon_docstring.py
View File

@@ -2026,6 +2026,7 @@ definition_after_normal_text : int
def test_tokenize_type_spec(self):
specs = (
"str",
"int, float, or complex",
"int or float or None, optional",
'{"F", "C", "N"}',
"{'F', 'C', 'N'}, default: 'F'",
@@ -2038,6 +2039,7 @@ definition_after_normal_text : int
tokens = (
["str"],
["int", ", ", "float", ", or ", "complex"],
["int", " or ", "float", " or ", "None", ", ", "optional"],
["{", '"F"', ", ", '"C"', ", ", '"N"', "}"],
["{", "'F'", ", ", "'C'", ", ", "'N'", "}", ", ", "default", ": ", "'F'"],
@@ -2136,6 +2138,8 @@ definition_after_normal_text : int
a optional parameter with fixed values
param6 : int, default None
different default format
param7 : mapping of hashable to str, optional
a optional mapping
""")
expected = dedent("""\
:param param1: the data to work on
@@ -2150,9 +2154,13 @@ definition_after_normal_text : int
:type param5: ``{"F", "C", "N"}``, *optional*
:param param6: different default format
:type param6: :class:`int`, *default* :obj:`None`
:param param7: a optional mapping
:type param7: :term:`mapping` of :term:`hashable` to :class:`str`, *optional*
""")
translations = {
"dict-like": ":term:`dict-like <mapping>`",
"mapping": ":term:`mapping`",
"hashable": ":term:`hashable`",
}
config = Config(
napoleon_use_param=True,