diff options
| author | Kevin Locke <kevin@kevinlocke.name> | 2019-02-17 10:12:24 -0700 |
|---|---|---|
| committer | Kevin Locke <kevin@kevinlocke.name> | 2019-02-17 10:40:50 -0700 |
| commit | 3300b1aca7f53a8468547194d074e1cb5bc55e15 (patch) | |
| tree | b91fa66db7c68e172c26ea6739a02ddb1786af2a /doc/ale-python.txt | |
| parent | c3d4e0983b4b08e61692cdd88990a79525a78707 (diff) | |
| download | ale-3300b1aca7f53a8468547194d074e1cb5bc55e15.zip | |
python/pylint: Change directory to project root
Pylint only [checks for pylintrc] (and .pylintrc) files in the packages
aboves its current directory before falling back to user and global
pylintrc. For projects with a src dir, running pylint from the
directory containing the file will not use the project pylintrc.
Adopt the convention used by many other Python linters of running from
the project root, which solves this issue. Add pylintrc and .pylintrc
to FindProjectRoot. Update docs.
[checks for pylintrc]: https://github.com/PyCQA/pylint/blob/pylint-2.2.2/pylint/config.py#L106
Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
Diffstat (limited to 'doc/ale-python.txt')
| -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* |