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

use the dedent function imported at module-level

Browse Source
This commit is contained in:
Keewis 2020-07-12 23:14:13 +02:00
parent f30c0cb9f6
commit 4fc22cd0c4
1 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
tests/test_ext_napoleon_docstring.py
View File

@ -2153,8 +2153,7 @@ definition_after_normal_text : int
self.assertEqual(expected, actual)
def test_parameter_types(self):
import textwrap
docstring = textwrap.dedent("""\
docstring = dedent("""\
Parameters
----------
param1 : DataFrame
@ -2168,17 +2167,17 @@ definition_after_normal_text : int
param5 : {"F", "C", "N"}, optional
a optional parameter with fixed values
""")
expected = textwrap.dedent("""\
:param param1: the data to work on
:type param1: DataFrame
: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 <mapping>`, *optional*
:param param4: a optional parameter with different types
:type param4: :obj:`int` or :obj:`float` or :obj:`None`, *optional*
:param param5: a optional parameter with fixed values
:type param5: ``{"F", "C", "N"}``, *optional*
expected = dedent("""\
:param param1: the data to work on
:type param1: DataFrame
: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 <mapping>`, *optional*
:param param4: a optional parameter with different types
:type param4: :obj:`int` or :obj:`float` or :obj:`None`, *optional*
:param param5: a optional parameter with fixed values
:type param5: ``{"F", "C", "N"}``, *optional*
""")
translations = {
"dict-like": ":term:`dict-like <mapping>`",