VimPlug/jedi
1
0
Fork 1
mirror of https://github.com/davidhalter/jedi.git synced 2025-12-10 07:41:51 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve settings documentation

Browse Source
This commit is contained in:
Dave Halter
2020-03-19 01:51:38 +01:00
parent e11db6e8e4
commit ffbaa4afea
1 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
jedi/settings.py
View File

@@ -51,22 +51,21 @@ import os
import platform import platform
# ---------------- # ----------------
# completion output settings # Completion Output Settings
# ---------------- # ----------------
case_insensitive_completion = True case_insensitive_completion = True
""" """
The completion is by default case insensitive. Completions are by default case insensitive.
""" """
add_bracket_after_function = False add_bracket_after_function = False
""" """
Adds an opening bracket after a function, because that's normal behaviour. Adds an opening bracket after a function for completions.
Removed it again, because in VIM that is not very practical.
""" """
# ---------------- # ----------------
# Filesystem cache # Filesystem Cache
# ---------------- # ----------------
if platform.system().lower() == 'windows': if platform.system().lower() == 'windows':
@@ -83,31 +82,32 @@ The path where the cache is stored.
On Linux, this defaults to ``~/.cache/jedi/``, on OS X to On Linux, this defaults to ``~/.cache/jedi/``, on OS X to
``~/Library/Caches/Jedi/`` and on Windows to ``%APPDATA%\\Jedi\\Jedi\\``. ``~/Library/Caches/Jedi/`` and on Windows to ``%APPDATA%\\Jedi\\Jedi\\``.
On Linux, if environment variable ``$XDG_CACHE_HOME`` is set, On Linux, if the environment variable ``$XDG_CACHE_HOME`` is set,
``$XDG_CACHE_HOME/jedi`` is used instead of the default one. ``$XDG_CACHE_HOME/jedi`` is used instead of the default one.
""" """
# ---------------- # ----------------
# parser # Parser
# ---------------- # ----------------
fast_parser = True fast_parser = True
""" """
Use the fast parser. This means that reparsing is only being done if Uses Parso's diff parser. If it is enabled, this might cause issues, please
something has been changed e.g. to a function. If this happens, only the read the warning on :class:`.Script`. This feature makes it possible to only
function is being reparsed. parse the parts again that have changed, while reusing the rest of the syntax
tree.
""" """
_cropped_file_size = 10e6 # 1 Megabyte _cropped_file_size = 10e6 # 1 Megabyte
""" """
Jedi gets extremely slow if the file size exceed a few thousand lines. Jedi gets extremely slow if the file size exceed a few thousand lines.
To avoid getting stuck completely Jedi crops the file this point. To avoid getting stuck completely Jedi crops the file at some point.
One megabyte of typical Python code equals about 20'000 lines of code. One megabyte of typical Python code equals about 20'000 lines of code.
""" """
# ---------------- # ----------------
# dynamic stuff # Dynamic Stuff
# ---------------- # ----------------
dynamic_array_additions = True dynamic_array_additions = True
@@ -135,13 +135,13 @@ auto_import_modules = [
'gi', # This third-party repository (GTK stuff) doesn't really work with jedi 'gi', # This third-party repository (GTK stuff) doesn't really work with jedi
] ]
""" """
Modules that are not analyzed but imported, although they contain Python code. Modules that will not be analyzed but imported, if they contain Python code.
This improves autocompletion for libraries that use ``setattr`` or This improves autocompletion for libraries that use ``setattr`` or
``globals()`` modifications a lot. ``globals()`` modifications a lot.
""" """
# ---------------- # ----------------
# caching validity (time) # Caching Validity
# ---------------- # ----------------
call_signatures_validity = 3.0 call_signatures_validity = 3.0