diff options
| author | w0rp <w0rp@users.noreply.github.com> | 2019-02-20 09:54:13 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-02-20 09:54:13 +0000 |
| commit | 707a42167f184355b64e1368a5e390dffc0cb885 (patch) | |
| tree | 4c92c8f141a4f4dda015d5c818c2150ad532b313 /doc | |
| parent | 09cbd70d9bc49dee421e0d4fdb252f8a77d8b1d6 (diff) | |
| parent | 3300b1aca7f53a8468547194d074e1cb5bc55e15 (diff) | |
| download | ale-707a42167f184355b64e1368a5e390dffc0cb885.zip | |
Merge pull request #2302 from kevinoid/pylint-cd-proj-root
python/pylint: Change directory to project root
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale-python.txt | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/ale-python.txt b/doc/ale-python.txt index f74e4e83..dd5d4cc6 100644 --- a/doc/ale-python.txt +++ b/doc/ale-python.txt @@ -32,6 +32,8 @@ ALE will look for configuration files with the following filenames. > flake8.cfg .flake8rc pylama.ini + pylintrc + .pylintrc Pipfile Pipfile.lock < @@ -512,10 +514,12 @@ g:ale_python_pylint_change_directory *g:ale_python_pylint_change_directory* Type: |Number| Default: `1` - If set to `1`, ALE will switch to the directory the Python file being - checked with `pylint` is in before checking it. This helps `pylint` find - configuration files more easily. This option can be turned off if you want - to control the directory Python is executed from yourself. + If set to `1`, `pylint` will be run from a detected project root, per + |ale-python-root|. Since `pylint` only checks for `pylintrc` in the packages + above its current directory before falling back to user and global `pylintrc` + files, this is necessary for `pylint` to use a project `pylintrc` file, if + present. This option can be turned off if you want to control the directory + Python is executed from yourself. g:ale_python_pylint_executable *g:ale_python_pylint_executable* |