tyler.durden/powerline
1
0
Fork 0
mirror of https://github.com/powerline/powerline.git synced 2025-07-26 15:25:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

Document powerline.lint.check function

Browse Source
This commit is contained in:
ZyX 2014-09-20 00:17:59 +04:00
parent e9e53aa85f
commit aeb1a32a33
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
powerline/lint/__init__.py
View File

@ -290,6 +290,24 @@ theme_spec = common_theme_spec().update(
def check(paths=None, debug=False, echoerr=echoerr, require_ext=None): def check(paths=None, debug=False, echoerr=echoerr, require_ext=None):
'''Check configuration sanity
:param list paths:
Paths from which configuration should be loaded.
:param bool debug:
Determines whether some information useful for debugging linter should
be output.
:param function echoerr:
Function that will be used to echo the error(s). Should accept four
optional keyword parameters: ``problem`` and ``problem_mark``, and
``context`` and ``context_mark``.
:param str require_ext:
Require configuration for some extension to be present.
:return:
``False`` if user configuration seems to be completely sane and ``True``
if some problems were found.
'''
search_paths = paths or get_config_paths() search_paths = paths or get_config_paths()
find_config_files = generate_config_finder(lambda: search_paths) find_config_files = generate_config_finder(lambda: search_paths)