VimPlug/ale
1
0
Fork 0
mirror of https://github.com/dense-analysis/ale.git synced 2026-05-20 07:19:49 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Doc style fixes (#4344)

Browse Source 
* ale.txt: fix indentation

* ale.txt: fix Type and Default markup

* ale.txt: use `not set` instead of `undefined`

This matches the way the variables are referenced in prose about
existence state.
This commit is contained in:
Ben Boeckel
2022-10-29 11:56:47 +00:00
committed by GitHub
parent 28cff80652
commit d02e58b404
16 changed files with 47 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/ale.txt
+11 -11
View File
@@ -750,7 +750,7 @@ g:airline#extensions#ale#enabled *g:airline#extensions#ale#enabled*
g:ale_cache_executable_check_failures *g:ale_cache_executable_check_failures*
Type: |Number|
Default: undefined
Default: not set
When set to `1`, ALE will cache failing executable checks for linters. By
default, only executable checks which succeed will be cached.
@@ -864,7 +864,7 @@ g:ale_completion_enabled *g:ale_completion_enabled*
*g:ale_completion_tsserver_remove_warnings*
g:ale_completion_tsserver_remove_warnings
Type: Number
Type: |Number|
Default: `0`
When this option is set to `0`, ALE will return all completion items,
@@ -874,7 +874,7 @@ g:ale_completion_tsserver_remove_warnings
g:ale_completion_autoimport *g:ale_completion_autoimport*
Type: Number
Type: |Number|
Default: `1`
When this option is set to `1`, ALE will try to automatically import
@@ -1836,7 +1836,7 @@ g:ale_max_signs *g:ale_max_signs*
g:ale_maximum_file_size *g:ale_maximum_file_size*
*b:ale_maximum_file_size*
Type: |Number|
Default: undefined
Default: not set
A maximum file size in bytes for ALE to check. If set to any positive
number, ALE will skip checking files larger than the given size.
@@ -1879,7 +1879,7 @@ g:ale_open_list *g:ale_open_list*
g:ale_pattern_options *g:ale_pattern_options*
Type: |Dictionary|
Default: undefined
Default: not set
This option maps regular expression patterns to |Dictionary| values for
buffer variables. This option can be set to automatically configure
@@ -1908,7 +1908,7 @@ g:ale_pattern_options *g:ale_pattern_options*
g:ale_pattern_options_enabled *g:ale_pattern_options_enabled*
Type: |Number|
Default: undefined
Default: not set
This option can be used for disabling pattern options. If set to `0`, ALE
will not set buffer variables per |g:ale_pattern_options|.
@@ -1954,7 +1954,7 @@ g:ale_root *g:ale_root*
*b:ale_root*
Type: |Dictionary| or |String|
Default: {}
Default: `{}`
This option is used to determine the project root for a linter. If the value
is a |Dictionary|, it maps a linter to either a |String| containing the
@@ -2006,7 +2006,7 @@ g:ale_set_balloons *g:ale_set_balloons*
g:ale_set_balloons_legacy_echo *g:ale_set_balloons_legacy_echo*
*b:ale_set_balloons_legacy_echo*
Type: |Number|
Default: undefined
Default: not set
If set to `1`, moving your mouse over documents in Vim will make ALE ask
`tsserver` or `LSP` servers for information about the symbol where the mouse
@@ -2240,10 +2240,10 @@ g:ale_sign_highlight_linenrs *g:ale_sign_highlight_linenrs*
g:ale_update_tagstack *g:ale_update_tagstack*
*b:ale_update_tagstack*
Type: |Number|
Default: `1`
Type: |Number|
Default: `1`
This option can be set to disable updating Vim's |tagstack| automatically.
This option can be set to disable updating Vim's |tagstack| automatically.
g:ale_type_map *g:ale_type_map*