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

allow mapping to a long name

Browse Source
This commit is contained in:
Keewis
2020-07-21 12:42:57 +02:00
parent 9b425606e7
commit ae35f81d3d
2 changed files with 14 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
tests/test_ext_napoleon_docstring.py
View File

@@ -2066,6 +2066,10 @@ definition_after_normal_text : int
self.assertEqual(expected, actual)
def test_convert_numpy_type_spec(self):
translations = {
"DataFrame": "pandas.DataFrame",
}
specs = (
"",
"optional",
@@ -2073,6 +2077,7 @@ definition_after_normal_text : int
"int or float or None, default: None",
'{"F", "C", "N"}',
"{'F', 'C', 'N'}, default: 'N'",
"DataFrame, optional",
)
converted = (
@@ -2082,10 +2087,11 @@ definition_after_normal_text : int
":class:`int` or :class:`float` or :obj:`None`, *default*: :obj:`None`",
'``{"F", "C", "N"}``',
"``{'F', 'C', 'N'}``, *default*: ``'N'``",
":class:`pandas.DataFrame`, *optional*",
)
for spec, expected in zip(specs, converted):
actual = _convert_numpy_type_spec(spec)
actual = _convert_numpy_type_spec(spec, translations=translations)
self.assertEqual(expected, actual)
def test_parameter_types(self):