From ffbaa4afea8d6bff1d9c5c7c7a0d0e801a90d7fd Mon Sep 17 00:00:00 2001
From: Dave Halter <davidhalter88@gmail.com>
Date: Thu, 19 Mar 2020 01:51:38 +0100
Subject: [PATCH] Improve settings documentation

---
 jedi/settings.py | 28 ++++++++++++++--------------
 1 file changed, 14 insertions(+), 14 deletions(-)

diff --git a/jedi/settings.py b/jedi/settings.py
index 9797f049..1573d59c 100644
--- a/jedi/settings.py
+++ b/jedi/settings.py
@@ -51,22 +51,21 @@ import os
 import platform
 
 # ----------------
-# completion output settings
+# Completion Output Settings
 # ----------------
 
 case_insensitive_completion = True
 """
-The completion is by default case insensitive.
+Completions are by default case insensitive.
 """
 
 add_bracket_after_function = False
 """
-Adds an opening bracket after a function, because that's normal behaviour.
-Removed it again, because in VIM that is not very practical.
+Adds an opening bracket after a function for completions.
 """
 
 # ----------------
-# Filesystem cache
+# Filesystem Cache
 # ----------------
 
 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
 ``~/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.
 """
 
 # ----------------
-# parser
+# Parser
 # ----------------
 
 fast_parser = True
 """
-Use the fast parser. This means that reparsing is only being done if
-something has been changed e.g. to a function. If this happens, only the
-function is being reparsed.
+Uses Parso's diff parser. If it is enabled, this might cause issues, please
+read the warning on :class:`.Script`. This feature makes it possible to only
+parse the parts again that have changed, while reusing the rest of the syntax
+tree.
 """
 
 _cropped_file_size = 10e6  # 1 Megabyte
 """
 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.
 """
 
 # ----------------
-# dynamic stuff
+# Dynamic Stuff
 # ----------------
 
 dynamic_array_additions = True
@@ -135,13 +135,13 @@ auto_import_modules = [
     '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
 ``globals()`` modifications a lot.
 """
 
 # ----------------
-# caching validity (time)
+# Caching Validity
 # ----------------
 
 call_signatures_validity = 3.0