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

change format_args to prefer annotations from typing.get_type_hints

Browse Source 
The current code looks for the pattern::

    class Node:
        def parent(self) -> 'Node': pass

This change allows more complex forward references::

    class Node:
        def children(self) -> Set['Node']: pass
This commit is contained in:
Terence Honles
2018-08-09 12:31:16 -07:00
committed by Terence D. Honles
parent 8a23ad1f44
commit 742c89f99b
1 changed files with 1 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
sphinx/util/inspect.py
View File

@@ -433,8 +433,7 @@ class Signature(object):
if PY2 or self.return_annotation is inspect.Parameter.empty:
return '(%s)' % ', '.join(args)
else:
if isinstance(self.return_annotation, string_types) and \
'return' in self.annotations:
if 'return' in self.annotations:
annotation = self.format_annotation(self.annotations['return'])
else:
annotation = self.format_annotation(self.return_annotation)