VimPlug/jedi
1
0
Fork 1
mirror of https://github.com/davidhalter/jedi.git synced 2025-12-18 11:35:57 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix a stub docs issue

Browse Source
This commit is contained in:
Dave Halter
2021-11-16 21:27:00 +01:00
parent 195695edd3
commit e580d1f4d9
2 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
jedi/inference/names.py
View File

@@ -341,6 +341,12 @@ class TreeNameDefinition(AbstractTreeName):
def py__doc__(self): def py__doc__(self):
api_type = self.api_type api_type = self.api_type
if api_type in ('function', 'class', 'property'): if api_type in ('function', 'class', 'property'):
if self.parent_context.get_root_context().is_stub():
from jedi.inference.gradual.conversion import convert_names
names = convert_names([self], prefer_stub_to_compiled=False)
if self not in names:
return _merge_name_docs(names)
# Make sure the names are not TreeNameDefinitions anymore. # Make sure the names are not TreeNameDefinitions anymore.
return clean_scope_docstring(self.tree_name.get_definition()) return clean_scope_docstring(self.tree_name.get_definition())

11
test/test_api/test_documentation.py
View File

@@ -37,6 +37,17 @@ def test_operator_doc(Script):
assert len(d.docstring()) > 100 assert len(d.docstring()) > 100
@pytest.mark.parametrize(
'code, help_part', [
('str', 'Create a new string object'),
('str.strip', 'Return a copy of the string'),
]
)
def test_stdlib_doc(Script, code, help_part):
h, = Script(code).help()
assert help_part in h.docstring(raw=True)
def test_lambda(Script): def test_lambda(Script):
d, = Script('lambda x: x').help(column=0) d, = Script('lambda x: x').help(column=0)
assert d.type == 'keyword' assert d.type == 'keyword'