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

Fix #9651: autodoc_typehints_description_target was confused by :returns:

Browse Source 
It only checks the existence of `:return:` field.  And it does not check
`:returns:` field.  It causes the absence of return types.
This commit is contained in:
Takeshi KOMIYA
2021-09-26 00:45:18 +09:00
parent 5fb51fb146
commit 5fb6fb6039
3 changed files with 17 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
tests/test_ext_autodoc_configs.py
View File

@@ -844,6 +844,10 @@ def test_autodoc_typehints_description_no_undoc(app):
(app.srcdir / 'index.rst').write_text(
'.. autofunction:: target.typehints.incr\n'
'\n'
'.. autofunction:: target.typehints.decr\n'
'\n'
' :returns: decremented number\n'
'\n'
'.. autofunction:: target.typehints.tuple_args\n'
'\n'
' :param x: arg\n'
@@ -852,6 +856,14 @@ def test_autodoc_typehints_description_no_undoc(app):
app.build()
context = (app.outdir / 'index.txt').read_text()
assert ('target.typehints.incr(a, b=1)\n'
'\n'
'target.typehints.decr(a, b=1)\n'
'\n'
' Returns:\n'
' decremented number\n'
'\n'
' Return type:\n'
' int\n'
'\n'
'target.typehints.tuple_args(x)\n'
'\n'