Document the virtualenv directories variable in the main file instead

1 files changed, 14 insertions, 0 deletions

diff --git a/doc/ale.txt b/doc/ale.txt
index c5e2f8f8..f1419d19 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -808,6 +808,20 @@ g:ale_type_map                                                 *g:ale_type_map*
   Type maps can be set per-buffer with `b:ale_type_map`.
 
 
+g:ale_virtualenv_dir_names                         *g:ale_virtualenv_dir_names*
+b:ale_virtualenv_dir_names                         *b:ale_virtualenv_dir_names*
+
+  Type: |List|
+  Default: `['.env', 'env', 've-py3', 've', 'virtualenv']`
+
+  A list of directory names to be used when searching upwards from Python
+  files to discover virtulenv directories with.
+
+  For directory named `'foo'`, ALE will search for `'foo/bin/activate'`
+  (`foo\Scripts\activate\` on Windows) in all directories on and above the
+  directory containing the Python file to find virtualenv paths.
+
+
 g:ale_warn_about_trailing_whitespace     *g:ale_warn_about_trailing_whitespace*
 b:ale_warn_about_trailing_whitespace     *b:ale_warn_about_trailing_whitespace*