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

Closes #1062: sphinx.ext.autodoc use __init__ method signature for class signature.

Browse Source
This commit is contained in:
Takayuki Shimizukawa
2013-02-03 20:27:34 +09:00
parent 4d4dad3610
commit e70a43a9c5
3 changed files with 28 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
tests/test_autodoc.py
View File

@@ -177,6 +177,20 @@ def test_format_signature():
assert formatsig('class', 'C', C, None, None) == '(a, b=None)'
assert formatsig('class', 'C', D, 'a, b', 'X') == '(a, b) -> X'
#__init__ have signature at first line of docstring
class F2:
'''some docstring for F2.'''
def __init__(self, *args, **kw):
'''
__init__(a1, a2, kw1=True, kw2=False)
some docstring for __init__.
'''
class G2(F2, object):
pass
for C in (F2, G2):
assert formatsig('class', 'C', C, None, None) == '(a1, a2, kw1=True, kw2=False)'
# test for methods
class H:
def foo1(self, b, *c):