summaryrefslogtreecommitdiff
path: root/doc/ale-python.txt
diff options
context:
space:
mode:
authorAiden Scandella <git@sca.ndella.com>2019-01-30 07:57:58 -0800
committerAiden Scandella <git@sca.ndella.com>2019-01-30 14:44:38 -0800
commitde29ff26ff536dbb99c57fc5f20ec6ee0b17a6c6 (patch)
treed26f9a667b2f091f9f7f7e4b0e172cdc2e3e4022 /doc/ale-python.txt
parent067601e9db7e0c2ab6c8394c9be74769463c6da9 (diff)
downloadale-de29ff26ff536dbb99c57fc5f20ec6ee0b17a6c6.zip
Respect python black fixer configuration file
Similar to other linters/fixers, by default change to the directory of the file being fixed before invoking `black`, which allows the tool to read project-specific configuration (pyproject.toml) Fixes #2218
Diffstat (limited to 'doc/ale-python.txt')
-rw-r--r--doc/ale-python.txt10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/ale-python.txt b/doc/ale-python.txt
index 175216f6..00faef03 100644
--- a/doc/ale-python.txt
+++ b/doc/ale-python.txt
@@ -139,6 +139,16 @@ g:ale_python_black_auto_pipenv *g:ale_python_black_auto_pipenv*
Detect whether the file is inside a pipenv, and set the executable to `pipenv`
if true. This is overridden by a manually-set executable.
+g:ale_python_black_change_directory *g:ale_python_black_change_directory*
+ *b:ale_python_black_change_directory*
+ Type: |Number|
+ Default: `1`
+
+ If set to `1`, ALE will switch to the directory the Python file being
+ checked with `black` is in before checking it. This helps `black` find
+ configuration files more easily. This option can be turned off if you want
+ to control the directory Python is executed from yourself.
+
===============================================================================
flake8 *ale-python-flake8*