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

Merge pull request #3933 from goodspark/py-rtype-xref

Browse Source 
Python rtypes should match classes, not all objects
This commit is contained in:
Takeshi KOMIYA 2017-07-16 11:50:19 +09:00 committed by GitHub
commit 0f4262c391
3 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
sphinx/domains/python.py
View File

@ -189,7 +189,7 @@ class PyObject(ObjectDescription):
Field('returnvalue', label=l_('Returns'), has_arg=False,
names=('returns', 'return')),
PyField('returntype', label=l_('Return type'), has_arg=False,
names=('rtype',), bodyrolename='obj'),
names=('rtype',), bodyrolename='class'),
]
allow_nesting = False

2
tests/roots/test-domain-py/module.rst
View File

@ -36,3 +36,5 @@ module
:type x: int
:param y: param y
:type y: tuple(str, float)
:rtype: list

3
tests/test_domain_py.py
View File

@ -113,7 +113,8 @@ def test_domain_py_xrefs(app, status, warning):
assert_refnode(refnodes[8], False, False, 'tuple', 'class')
assert_refnode(refnodes[9], False, False, 'str', 'class')
assert_refnode(refnodes[10], False, False, 'float', 'class')
assert len(refnodes) == 11
assert_refnode(refnodes[11], False, False, 'list', 'class')
assert len(refnodes) == 12
@pytest.mark.sphinx('dummy', testroot='domain-py')