VimPlug/jedi-fork
1
0
Fork 0
forked from VimPlug/jedi
Code Pull Requests Activity

add a Documentation() class to the API, which will be used in the future for all kind of docstrings. Also add a documentation method on BaseDefinition that returns a Documentation object. Deprecate at the same time its doc and raw_doc functions

Browse Source
This commit is contained in:
Dave Halter
2014-03-25 02:14:34 +01:00
parent fa664534e4
commit 3f3788e800
3 changed files with 44 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
test/test_api/test_api_classes.py
View File

@@ -93,7 +93,7 @@ def test_function_call_signature_in_doc():
pass
f""").goto_definitions()
doc = defs[0].doc
assert "f(x, y = 1, z = 'a')" in doc
assert "f(x, y = 1, z = 'a')" in str(doc)
def test_class_call_signature():
@@ -103,7 +103,7 @@ def test_class_call_signature():
pass
Foo""").goto_definitions()
doc = defs[0].doc
assert "Foo(self, x, y = 1, z = 'a')" in doc
assert "Foo(self, x, y = 1, z = 'a')" in str(doc)
def test_position_none_if_builtin():

2
test/test_api/test_call_signatures.py
View File

@@ -193,7 +193,7 @@ def test_signature_is_definition():
# Now compare all the attributes that a CallSignature must also have.
for attr_name in dir(definition):
dont_scan = ['defined_names', 'line_nr', 'start_pos']
dont_scan = ['defined_names', 'line_nr', 'start_pos', 'documentation', 'doc']
if attr_name.startswith('_') or attr_name in dont_scan:
continue
attribute = getattr(definition, attr_name)