summaryrefslogtreecommitdiff
path: root/tests/test_ext_napoleon_docstring.py
diff options
context:
space:
mode:
authorKeewis <keewis@posteo.de>2020-07-12 23:14:13 +0200
committerKeewis <keewis@posteo.de>2020-07-16 00:27:00 +0200
commit4fc22cd0c40290e52a6ee5820ac54d1db309496d (patch)
tree1134c88e28dd0db9d9c515bd68a3ef2977f61174 /tests/test_ext_napoleon_docstring.py
parentf30c0cb9f674baa0048b9d3d6a8cad85807c52c0 (diff)
downloadsphinx-git-4fc22cd0c40290e52a6ee5820ac54d1db309496d.tar.gz
use the dedent function imported at module-level
Diffstat (limited to 'tests/test_ext_napoleon_docstring.py')
-rw-r--r--tests/test_ext_napoleon_docstring.py25
1 files changed, 12 insertions, 13 deletions
diff --git a/tests/test_ext_napoleon_docstring.py b/tests/test_ext_napoleon_docstring.py
index 5c0941398..7a273b26a 100644
--- a/tests/test_ext_napoleon_docstring.py
+++ b/tests/test_ext_napoleon_docstring.py
@@ -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>`",