VimPlug/ale
1
0
Fork 0
mirror of https://github.com/dense-analysis/ale.git synced 2025-12-16 09:17:07 +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

2
doc/ale-eruby.txt
View File

@@ -39,7 +39,7 @@ ruumba *ale-eruby-ruumba*
g:ale_eruby_ruumba_executable *g:ale_eruby_ruumba_executable* g:ale_eruby_ruumba_executable *g:ale_eruby_ruumba_executable*
*b:ale_eruby_ruumba_executable* *b:ale_eruby_ruumba_executable*
Type: String Type: |String|
Default: `'ruumba` Default: `'ruumba`
Override the invoked ruumba binary. This is useful for running ruumba Override the invoked ruumba binary. This is useful for running ruumba

2
doc/ale-go.txt
View File

@@ -169,7 +169,7 @@ g:ale_go_golines_executable *g:ale_go_lines_executable*
g:ale_go_golines_options *g:ale_go_golines_options* g:ale_go_golines_options *g:ale_go_golines_options*
*b:ale_go_golines_options* *b:ale_go_golines_options*
Type: |String| Type: |String|
Default: '' Default: `''`
Additional options passed to the golines command. By default golines has Additional options passed to the golines command. By default golines has
--max-length=100 (lines above 100 characters will be wrapped) --max-length=100 (lines above 100 characters will be wrapped)

8
doc/ale-haskell.txt
View File

@@ -123,8 +123,8 @@ g:ale_haskell_hlint_executable *g:ale_haskell_hlint_executable*
g:ale_haskell_hlint_options g:ale_haskell_hlint_options g:ale_haskell_hlint_options g:ale_haskell_hlint_options
b:ale_haskell_hlint_options b:ale_haskell_hlint_options
Type: String Type: |String|
Default: '' Default: `''`
This variable can be used to pass extra options to the underlying hlint This variable can be used to pass extra options to the underlying hlint
executable. executable.
@@ -217,8 +217,8 @@ g:ale_haskell_ormolu_executable *g:ale_haskell_ormolu_executable*
g:ale_haskell_ormolu_options *g:ale_haskell_ormolu_options* g:ale_haskell_ormolu_options *g:ale_haskell_ormolu_options*
*b:ale_haskell_ormolu_options* *b:ale_haskell_ormolu_options*
Type: String Type: |String|
Default: '' Default: `''`
This variable can be used to pass extra options to the underlying ormolu This variable can be used to pass extra options to the underlying ormolu
executable. executable.

6
doc/ale-java.txt
View File

@@ -24,7 +24,7 @@ g:ale_java_checkstyle_executable *g:ale_java_checkstyle_executable*
*b:ale_java_checkstyle_executable* *b:ale_java_checkstyle_executable*
Type: |String| Type: |String|
Default: 'checkstyle' Default: `'checkstyle'`
This variable can be changed to modify the executable used for checkstyle. This variable can be changed to modify the executable used for checkstyle.
@@ -124,8 +124,8 @@ pmd *ale-java-pmd*
g:ale_java_pmd_options *g:ale_java_pmd_options* g:ale_java_pmd_options *g:ale_java_pmd_options*
*b:ale_java_pmd_options* *b:ale_java_pmd_options*
Type: String Type: |String|
Default: '-R category/java/bestpractices' Default: `'-R category/java/bestpractices'`
This variable can be changed to modify flags given to PMD. Do not specify -f This variable can be changed to modify flags given to PMD. Do not specify -f
and -d. They are added automatically. and -d. They are added automatically.

2
doc/ale-julia.txt
View File

@@ -11,7 +11,7 @@ g:ale_julia_executable *g:ale_julia_executable*
*b:ale_julia_executable* *b:ale_julia_executable*
Type: |String| Type: |String|
Default: 'julia' Default: `'julia'`
Path to the julia exetuable. Path to the julia exetuable.

2
doc/ale-kotlin.txt
View File

@@ -79,7 +79,7 @@ g:ale_kotlin_ktlint_executable *g:ale_kotlin_ktlint_executable*
g:ale_kotlin_ktlint_rulesets *g:ale_kotlin_ktlint_rulesets* g:ale_kotlin_ktlint_rulesets *g:ale_kotlin_ktlint_rulesets*
Type: |List| of |String|s Type: |List| of |String|s
Default: [] Default: `[]`
This list should contain paths to ruleset jars and/or strings of maven This list should contain paths to ruleset jars and/or strings of maven
artifact triples. Example: artifact triples. Example:

2
doc/ale-llvm.txt
View File

@@ -9,7 +9,7 @@ g:ale_llvm_llc_executable *g:ale_llvm_llc_executable*
*b:ale_llvm_llc_executable* *b:ale_llvm_llc_executable*
Type: |String| Type: |String|
Default: "llc" Default: `"llc"`
The command to use for checking. This variable is useful when llc command The command to use for checking. This variable is useful when llc command
has suffix like "llc-5.0". has suffix like "llc-5.0".

2
doc/ale-perl.txt
View File

@@ -72,7 +72,7 @@ g:ale_perl_perlcritic_options *g:ale_perl_perlcritic_options*
g:ale_perl_perlcritic_showrules *g:ale_perl_perlcritic_showrules* g:ale_perl_perlcritic_showrules *g:ale_perl_perlcritic_showrules*
Type: |Number| Type: |Number|
Default: 0 Default: `0`
Controls whether perlcritic rule names are shown after the error message. Controls whether perlcritic rule names are shown after the error message.
Defaults to off to reduce length of message. Defaults to off to reduce length of message.

2
doc/ale-powershell.txt
View File

@@ -13,7 +13,7 @@ powershell *ale-powershell-powershell*
g:ale_powershell_powershell_executable *g:ale_powershell_powershell_executable* g:ale_powershell_powershell_executable *g:ale_powershell_powershell_executable*
*b:ale_powershell_powershell_executable* *b:ale_powershell_powershell_executable*
Type: String Type: |String|
Default: `'pwsh'` Default: `'pwsh'`
This variable can be changed to use a different executable for powershell. This variable can be changed to use a different executable for powershell.

6
doc/ale-proto.txt
View File

@@ -25,7 +25,7 @@ buf-format *ale-proto-buf-format*
g:ale_proto_buf_format_executable *g:ale_proto_buf_format_executable* g:ale_proto_buf_format_executable *g:ale_proto_buf_format_executable*
Type: |String| Type: |String|
Default: 'buf' Default: `'buf'`
This variable can be changed to modify the executable used for buf. This variable can be changed to modify the executable used for buf.
@@ -39,7 +39,7 @@ buf-lint *ale-proto-buf-lint*
g:ale_proto_buf_lint_executable *g:ale_proto_buf_lint_executable* g:ale_proto_buf_lint_executable *g:ale_proto_buf_lint_executable*
Type: |String| Type: |String|
Default: 'buf' Default: `'buf'`
This variable can be changed to modify the executable used for buf. This variable can be changed to modify the executable used for buf.
@@ -80,7 +80,7 @@ protolint *ale-proto-protolint
g:ale_proto_protolint_executable *g:ale_proto_protolint_executable* g:ale_proto_protolint_executable *g:ale_proto_protolint_executable*
Type: |String| Type: |String|
Default: 'protolint' Default: `'protolint'`
This variable can be changed to modify the executable used for protolint. This variable can be changed to modify the executable used for protolint.

2
doc/ale-purescript.txt
View File

@@ -48,7 +48,7 @@ g:ale_purescript_tidy_use_global *g:ale_purescript_tidy_use_global*
g:ale_purescript_tidy_options *g:ale_purescript_tidy_options* g:ale_purescript_tidy_options *g:ale_purescript_tidy_options*
*b:ale_purescript_tidy_options* *b:ale_purescript_tidy_options*
Type: String Type: |String|
Default: `''` Default: `''`
This variable can be set to pass in additional option to the 'purs-tidy' This variable can be set to pass in additional option to the 'purs-tidy'

28
doc/ale-ruby.txt
View File

@@ -7,7 +7,7 @@ brakeman *ale-ruby-brakeman*
g:ale_ruby_brakeman_executable *g:ale_ruby_brakeman_executable* g:ale_ruby_brakeman_executable *g:ale_ruby_brakeman_executable*
*b:ale_ruby_brakeman_executable* *b:ale_ruby_brakeman_executable*
Type: String Type: |String|
Default: `'brakeman'` Default: `'brakeman'`
Override the invoked brakeman binary. Set this to `'bundle'` to invoke Override the invoked brakeman binary. Set this to `'bundle'` to invoke
@@ -33,7 +33,7 @@ debride *ale-ruby-debride*
g:ale_ruby_debride_executable *g:ale_ruby_debride_executable* g:ale_ruby_debride_executable *g:ale_ruby_debride_executable*
*b:ale_ruby_debride_executable* *b:ale_ruby_debride_executable*
Type: String Type: |String|
Default: `'debride'` Default: `'debride'`
Override the invoked debride binary. Set this to `'bundle'` to invoke Override the invoked debride binary. Set this to `'bundle'` to invoke
@@ -60,7 +60,7 @@ rails_best_practices *ale-ruby-rails_best_practices*
g:ale_ruby_rails_best_practices_executable g:ale_ruby_rails_best_practices_executable
*g:ale_ruby_rails_best_practices_executable* *g:ale_ruby_rails_best_practices_executable*
*b:ale_ruby_rails_best_practices_executable* *b:ale_ruby_rails_best_practices_executable*
Type: String Type: |String|
Default: `'rails_best_practices'` Default: `'rails_best_practices'`
Override the invoked rails_best_practices binary. Set this to `'bundle'` to Override the invoked rails_best_practices binary. Set this to `'bundle'` to
@@ -81,7 +81,7 @@ reek *ale-ruby-reek*
g:ale_ruby_reek_executable *g:ale_ruby_reek_executable* g:ale_ruby_reek_executable *g:ale_ruby_reek_executable*
*b:ale_ruby_reek_executable* *b:ale_ruby_reek_executable*
Type: String Type: |String|
Default: `'reek'` Default: `'reek'`
Override the invoked reek binary. Set this to `'bundle'` to invoke Override the invoked reek binary. Set this to `'bundle'` to invoke
@@ -91,7 +91,7 @@ g:ale_ruby_reek_executable *g:ale_ruby_reek_executable*
g:ale_ruby_reek_show_context *g:ale_ruby_reek_show_context* g:ale_ruby_reek_show_context *g:ale_ruby_reek_show_context*
*b:ale_ruby_reek_show_context* *b:ale_ruby_reek_show_context*
Type: |Number| Type: |Number|
Default: 0 Default: `0`
Controls whether context is included in the linter message. Defaults to off Controls whether context is included in the linter message. Defaults to off
because context is usually obvious while viewing a file. because context is usually obvious while viewing a file.
@@ -100,7 +100,7 @@ g:ale_ruby_reek_show_context *g:ale_ruby_reek_show_context*
g:ale_ruby_reek_show_wiki_link *g:ale_ruby_reek_show_wiki_link* g:ale_ruby_reek_show_wiki_link *g:ale_ruby_reek_show_wiki_link*
*b:ale_ruby_reek_show_wiki_link* *b:ale_ruby_reek_show_wiki_link*
Type: |Number| Type: |Number|
Default: 0 Default: `0`
Controls whether linter messages contain a link to an explanatory wiki page Controls whether linter messages contain a link to an explanatory wiki page
for the type of code smell. Defaults to off to improve readability. for the type of code smell. Defaults to off to improve readability.
@@ -111,7 +111,7 @@ rubocop *ale-ruby-rubocop*
g:ale_ruby_rubocop_executable *g:ale_ruby_rubocop_executable* g:ale_ruby_rubocop_executable *g:ale_ruby_rubocop_executable*
*b:ale_ruby_rubocop_executable* *b:ale_ruby_rubocop_executable*
Type: String Type: |String|
Default: `'rubocop'` Default: `'rubocop'`
Override the invoked rubocop binary. Set this to `'bundle'` to invoke Override the invoked rubocop binary. Set this to `'bundle'` to invoke
@@ -128,7 +128,7 @@ g:ale_ruby_rubocop_options *g:ale_ruby_rubocop_options*
g:ale_ruby_rubocop_auto_correct_all *g:ale_ruby_rubocop_auto_correct_all* g:ale_ruby_rubocop_auto_correct_all *g:ale_ruby_rubocop_auto_correct_all*
*b:ale_ruby_rubocop_auto_correct_all* *b:ale_ruby_rubocop_auto_correct_all*
Type: Number Type: |Number|
Default: `0` Default: `0`
This variable can be changed to make rubocop to correct all offenses (unsafe). This variable can be changed to make rubocop to correct all offenses (unsafe).
@@ -139,7 +139,7 @@ ruby *ale-ruby-ruby*
g:ale_ruby_ruby_executable *g:ale_ruby_ruby_executable* g:ale_ruby_ruby_executable *g:ale_ruby_ruby_executable*
*b:ale_ruby_ruby_executable* *b:ale_ruby_ruby_executable*
Type: String Type: |String|
Default: `'ruby'` Default: `'ruby'`
This variable can be changed to use a different executable for ruby. This variable can be changed to use a different executable for ruby.
@@ -150,7 +150,7 @@ rufo *ale-ruby-rufo*
g:ale_ruby_rufo_executable *g:ale_ruby_rufo_executable* g:ale_ruby_rufo_executable *g:ale_ruby_rufo_executable*
*b:ale_ruby_rufo_executable* *b:ale_ruby_rufo_executable*
Type: String Type: |String|
Default: `'rufo'` Default: `'rufo'`
Override the invoked rufo binary. This is useful for running rufo from Override the invoked rufo binary. This is useful for running rufo from
@@ -162,7 +162,7 @@ solargraph *ale-ruby-solargraph*
g:ale_ruby_solargraph_executable *g:ale_ruby_solargraph_executable* g:ale_ruby_solargraph_executable *g:ale_ruby_solargraph_executable*
*b:ale_ruby_solargraph_executable* *b:ale_ruby_solargraph_executable*
Type: String Type: |String|
Default: `'solargraph'` Default: `'solargraph'`
Override the invoked solargraph binary. This is useful for running solargraph Override the invoked solargraph binary. This is useful for running solargraph
@@ -174,7 +174,7 @@ sorbet *ale-ruby-sorbet*
g:ale_ruby_sorbet_executable *g:ale_ruby_sorbet_executable* g:ale_ruby_sorbet_executable *g:ale_ruby_sorbet_executable*
*b:ale_ruby_sorbet_executable* *b:ale_ruby_sorbet_executable*
Type: String Type: |String|
Default: `'srb'` Default: `'srb'`
Override the invoked sorbet binary. Set this to `'bundle'` to invoke Override the invoked sorbet binary. Set this to `'bundle'` to invoke
@@ -204,7 +204,7 @@ standardrb *ale-ruby-standardrb*
g:ale_ruby_standardrb_executable *g:ale_ruby_standardrb_executable* g:ale_ruby_standardrb_executable *g:ale_ruby_standardrb_executable*
*b:ale_ruby_standardrb_executable* *b:ale_ruby_standardrb_executable*
Type: String Type: |String|
Default: `'standardrb'` Default: `'standardrb'`
Override the invoked standardrb binary. Set this to `'bundle'` to invoke Override the invoked standardrb binary. Set this to `'bundle'` to invoke
@@ -224,7 +224,7 @@ syntax_tree *ale-ruby-syntax_tree*
g:ale_ruby_syntax_tree_executable *g:ale_ruby_syntax_tree_executable* g:ale_ruby_syntax_tree_executable *g:ale_ruby_syntax_tree_executable*
*b:ale_ruby_syntax_tree_executable* *b:ale_ruby_syntax_tree_executable*
Type: String Type: |String|
Default: `'stree'` Default: `'stree'`
Override the invoked SyntaxTree binary. Set this to `'bundle'` to invoke Override the invoked SyntaxTree binary. Set this to `'bundle'` to invoke

4
doc/ale-rust.txt
View File

@@ -261,8 +261,8 @@ g:ale_rust_ignore_error_codes *g:ale_rust_ignore_error_codes*
g:ale_rust_ignore_secondary_spans *g:ale_rust_ignore_secondary_spans* g:ale_rust_ignore_secondary_spans *g:ale_rust_ignore_secondary_spans*
*b:ale_rust_ignore_secondary_spans* *b:ale_rust_ignore_secondary_spans*
Type: Number Type: |Number|
Default: 0 Default: `0`
When set to 1, instructs the Rust error reporting to ignore secondary spans. When set to 1, instructs the Rust error reporting to ignore secondary spans.
The problem with secondary spans is that they sometimes appear in error The problem with secondary spans is that they sometimes appear in error

2
doc/ale-tex.txt
View File

@@ -33,7 +33,7 @@ lacheck *ale-tex-lacheck*
g:ale_lacheck_executable *g:ale_lacheck_executable* g:ale_lacheck_executable *g:ale_lacheck_executable*
*b:ale_lacheck_executable* *b:ale_lacheck_executable*
Type: |String| Type: |String|
Default: '`lacheck`' Default: `'lacheck'`
This variable can be changed to change the path to lacheck. This variable can be changed to change the path to lacheck.

2
doc/ale-xml.txt
View File

@@ -24,7 +24,7 @@ g:ale_xml_xmllint_options *g:ale_xml_xmllint_options*
g:ale_xml_xmllint_indentsize *g:ale_xml_xmllint_indentsize* g:ale_xml_xmllint_indentsize *g:ale_xml_xmllint_indentsize*
*b:ale_xml_xmllint_indentsize* *b:ale_xml_xmllint_indentsize*
Type: |Number| Type: |Number|
Default: 2 Default: `2`
This variable can be sent to specify the amount of spaces used for This variable can be sent to specify the amount of spaces used for
indentation. indentation.

22
doc/ale.txt
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* g:ale_cache_executable_check_failures *g:ale_cache_executable_check_failures*
Type: |Number| Type: |Number|
Default: undefined Default: not set
When set to `1`, ALE will cache failing executable checks for linters. By When set to `1`, ALE will cache failing executable checks for linters. By
default, only executable checks which succeed will be cached. 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*
g:ale_completion_tsserver_remove_warnings g:ale_completion_tsserver_remove_warnings
Type: Number Type: |Number|
Default: `0` Default: `0`
When this option is set to `0`, ALE will return all completion items, 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* g:ale_completion_autoimport *g:ale_completion_autoimport*
Type: Number Type: |Number|
Default: `1` Default: `1`
When this option is set to `1`, ALE will try to automatically import 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* g:ale_maximum_file_size *g:ale_maximum_file_size*
*b:ale_maximum_file_size* *b:ale_maximum_file_size*
Type: |Number| Type: |Number|
Default: undefined Default: not set
A maximum file size in bytes for ALE to check. If set to any positive 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. 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* g:ale_pattern_options *g:ale_pattern_options*
Type: |Dictionary| Type: |Dictionary|
Default: undefined Default: not set
This option maps regular expression patterns to |Dictionary| values for This option maps regular expression patterns to |Dictionary| values for
buffer variables. This option can be set to automatically configure 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* g:ale_pattern_options_enabled *g:ale_pattern_options_enabled*
Type: |Number| Type: |Number|
Default: undefined Default: not set
This option can be used for disabling pattern options. If set to `0`, ALE This option can be used for disabling pattern options. If set to `0`, ALE
will not set buffer variables per |g:ale_pattern_options|. will not set buffer variables per |g:ale_pattern_options|.
@@ -1954,7 +1954,7 @@ g:ale_root *g:ale_root*
*b:ale_root* *b:ale_root*
Type: |Dictionary| or |String| Type: |Dictionary| or |String|
Default: {} Default: `{}`
This option is used to determine the project root for a linter. If the value 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 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* g:ale_set_balloons_legacy_echo *g:ale_set_balloons_legacy_echo*
*b:ale_set_balloons_legacy_echo* *b:ale_set_balloons_legacy_echo*
Type: |Number| Type: |Number|
Default: undefined Default: not set
If set to `1`, moving your mouse over documents in Vim will make ALE ask 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 `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* g:ale_update_tagstack *g:ale_update_tagstack*
*b:ale_update_tagstack* *b:ale_update_tagstack*
Type: |Number| Type: |Number|
Default: `1` 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* g:ale_type_map *g:ale_type_map*