summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatteo Centenaro <bugant@gmail.com>2017-07-12 10:00:42 +0200
committerMatteo Centenaro <bugant@gmail.com>2017-07-12 10:00:42 +0200
commitff80b23ee13d8693f7db8dc7aaf335f26c1da68e (patch)
tree2205b69e69aab9129eb938be274b3bf96c4253c7
parent340c0bbac53df00c2d0c00d3e626776c4a6016bf (diff)
downloadale-ff80b23ee13d8693f7db8dc7aaf335f26c1da68e.zip
Fix docs for FindProjectRoot function
-rw-r--r--autoload/ale/python.vim6
1 files changed, 5 insertions, 1 deletions
diff --git a/autoload/ale/python.vim b/autoload/ale/python.vim
index c4fb28f5..ed5064d5 100644
--- a/autoload/ale/python.vim
+++ b/autoload/ale/python.vim
@@ -28,7 +28,11 @@ endfunction
" Given a buffer number, find the project root directory for Python.
" The root directory is defined as the first directory found while searching
" upwards through paths, including the current directory, until a path
-" containing no __init__.py files is found.
+" containing an init file (one from MANIFEST.in, setup.cfg, pytest.ini,
+" tox.ini) is found. If it is not possible to find the project root directorty
+" via init file, then it will be defined as the first directory found
+" searching upwards through paths, including the current directory, until no
+" __init__.py files is found.
function! ale#python#FindProjectRoot(buffer) abort
let l:ini_root = ale#python#FindProjectRootIni(a:buffer)