mirror of
https://github.com/davidhalter/jedi.git
synced 2025-12-06 14:04:26 +08:00
Include function return type annotation in docstring if it is present
This commit is contained in:
committed by
Dave Halter
parent
88243d2408
commit
ceb5509170
@@ -50,5 +50,6 @@ Anton Zub (@zabulazza)
|
|||||||
Maksim Novikov (@m-novikov) <mnovikov.work@gmail.com>
|
Maksim Novikov (@m-novikov) <mnovikov.work@gmail.com>
|
||||||
Tobias Rzepka (@TobiasRzepka)
|
Tobias Rzepka (@TobiasRzepka)
|
||||||
micbou (@micbou)
|
micbou (@micbou)
|
||||||
|
Dima Gerasimov (@karlicoss) <karlicoss@gmail.com>
|
||||||
|
|
||||||
Note: (@user) means a github user name.
|
Note: (@user) means a github user name.
|
||||||
|
|||||||
@@ -156,7 +156,11 @@ def get_call_signature(funcdef, width=72, call_string=None):
|
|||||||
p = '(' + ''.join(param.get_code() for param in funcdef.get_params()).strip() + ')'
|
p = '(' + ''.join(param.get_code() for param in funcdef.get_params()).strip() + ')'
|
||||||
else:
|
else:
|
||||||
p = funcdef.children[2].get_code()
|
p = funcdef.children[2].get_code()
|
||||||
code = call_string + p
|
if funcdef.annotation:
|
||||||
|
rtype = " ->" + funcdef.annotation.get_code()
|
||||||
|
else:
|
||||||
|
rtype = ""
|
||||||
|
code = call_string + p + rtype
|
||||||
|
|
||||||
return '\n'.join(textwrap.wrap(code, width))
|
return '\n'.join(textwrap.wrap(code, width))
|
||||||
|
|
||||||
|
|||||||
@@ -75,7 +75,8 @@ def test_hex_values_in_docstring():
|
|||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
'code,call_signature', [
|
'code,call_signature', [
|
||||||
('def my_function(x, y, z) -> str:\n return', 'my_function(x, y, z)'),
|
('def my_function(x, typed: Type, z):\n return', 'my_function(x, typed: Type, z)'),
|
||||||
|
('def my_function(x, y, z) -> str:\n return', 'my_function(x, y, z) -> str'),
|
||||||
('lambda x, y, z: x + y * z\n', '<lambda>(x, y, z)')
|
('lambda x, y, z: x + y * z\n', '<lambda>(x, y, z)')
|
||||||
])
|
])
|
||||||
def test_get_call_signature(code, call_signature):
|
def test_get_call_signature(code, call_signature):
|
||||||
|
|||||||
Reference in New Issue
Block a user