VimPlug/jedi
1
0
Fork 1
mirror of https://github.com/davidhalter/jedi.git synced 2026-01-28 20:22:10 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improved plugin api documentation

Browse Source
This commit is contained in:
Danilo Bargen
2012-12-30 04:31:34 +01:00
parent cd4727ea9c
commit a4e1fe47fd
5 changed files with 79 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
jedi/api_classes.py
View File

@@ -1,6 +1,7 @@
"""`api_classes` contains the return classes of the API. These classes are the
much bigger part of the whole API, because here you get out the information
about completion and goto operations.
"""
The :mod:`api_classes` module contains the return classes of the API. These
classes are the much bigger part of the whole API, because they contain the
interesting information about completion and goto operations.
"""
import re
@@ -20,7 +21,7 @@ import keywords
def _clear_caches():
"""
Clears all caches of this and related modules. The only cache that will not
Clear all caches of this and related modules. The only cache that will not
be deleted is the module cache.
"""
cache.clear_caches()
@@ -231,7 +232,7 @@ class Completion(BaseDefinition):
def follow_definition(self):
"""
Return the original definitions. I strongly recommend not using it for
your completions, because it might slow down *Jedi*. If you want to read
your completions, because it might slow down |jedi|. If you want to read
only a few objects (<=20), it might be useful, especially to
get the original docstrings. The basic problem of this function is
that it follows all results. This means with 1000 completions (e.g.