diff options
Diffstat (limited to 'tests/test_autodoc.py')
| -rw-r--r-- | tests/test_autodoc.py | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/tests/test_autodoc.py b/tests/test_autodoc.py index e8a7d29f3..3e9b4f25c 100644 --- a/tests/test_autodoc.py +++ b/tests/test_autodoc.py @@ -32,6 +32,8 @@ def setup_module(): options = Struct( inherited_members = False, undoc_members = False, + private_members = False, + special_members = False, show_inheritance = False, noindex = False, synopsis = '', @@ -501,6 +503,13 @@ def test_generate(): 'attribute', 'mdocattr') del directive.env.temp_data['autodoc:class'] + # test autodoc_docstring_signature + assert_result_contains( + '.. py:method:: DocstringSig.meth(FOO, BAR=1) -> BAZ', 'method', + 'test_autodoc.DocstringSig.meth') + assert_result_contains( + ' rest of docstring', 'method', 'test_autodoc.DocstringSig.meth') + # --- generate fodder ------------ @@ -595,3 +604,12 @@ class Outer(object): # should be documented as an alias factory = dict + + +class DocstringSig(object): + def meth(self): + """meth(FOO, BAR=1) -> BAZ +First line of docstring + + rest of docstring + """ |