diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ale-eruby.txt | 2 | ||||
| -rw-r--r-- | doc/ale-go.txt | 2 | ||||
| -rw-r--r-- | doc/ale-haskell.txt | 8 | ||||
| -rw-r--r-- | doc/ale-java.txt | 6 | ||||
| -rw-r--r-- | doc/ale-julia.txt | 2 | ||||
| -rw-r--r-- | doc/ale-kotlin.txt | 2 | ||||
| -rw-r--r-- | doc/ale-llvm.txt | 2 | ||||
| -rw-r--r-- | doc/ale-perl.txt | 2 | ||||
| -rw-r--r-- | doc/ale-powershell.txt | 2 | ||||
| -rw-r--r-- | doc/ale-proto.txt | 6 | ||||
| -rw-r--r-- | doc/ale-purescript.txt | 2 | ||||
| -rw-r--r-- | doc/ale-ruby.txt | 28 | ||||
| -rw-r--r-- | doc/ale-rust.txt | 4 | ||||
| -rw-r--r-- | doc/ale-tex.txt | 2 | ||||
| -rw-r--r-- | doc/ale-xml.txt | 2 | ||||
| -rw-r--r-- | doc/ale.txt | 22 |
16 files changed, 47 insertions, 47 deletions
diff --git a/doc/ale-eruby.txt b/doc/ale-eruby.txt index 48a34895..4cf08d07 100644 --- a/doc/ale-eruby.txt +++ b/doc/ale-eruby.txt @@ -39,7 +39,7 @@ ruumba *ale-eruby-ruumba* g:ale_eruby_ruumba_executable *g:ale_eruby_ruumba_executable* *b:ale_eruby_ruumba_executable* - Type: String + Type: |String| Default: `'ruumba` Override the invoked ruumba binary. This is useful for running ruumba diff --git a/doc/ale-go.txt b/doc/ale-go.txt index bce85470..367618ea 100644 --- a/doc/ale-go.txt +++ b/doc/ale-go.txt @@ -169,7 +169,7 @@ g:ale_go_golines_executable *g:ale_go_lines_executable* g:ale_go_golines_options *g:ale_go_golines_options* *b:ale_go_golines_options* Type: |String| - Default: '' + Default: `''` Additional options passed to the golines command. By default golines has --max-length=100 (lines above 100 characters will be wrapped) diff --git a/doc/ale-haskell.txt b/doc/ale-haskell.txt index 10b676d7..bd5a5edf 100644 --- a/doc/ale-haskell.txt +++ b/doc/ale-haskell.txt @@ -123,8 +123,8 @@ g:ale_haskell_hlint_executable *g:ale_haskell_hlint_executable* g:ale_haskell_hlint_options g:ale_haskell_hlint_options b:ale_haskell_hlint_options - Type: String - Default: '' + Type: |String| + Default: `''` This variable can be used to pass extra options to the underlying hlint 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* *b:ale_haskell_ormolu_options* - Type: String - Default: '' + Type: |String| + Default: `''` This variable can be used to pass extra options to the underlying ormolu executable. diff --git a/doc/ale-java.txt b/doc/ale-java.txt index d9e85d3b..8767c791 100644 --- a/doc/ale-java.txt +++ b/doc/ale-java.txt @@ -24,7 +24,7 @@ g:ale_java_checkstyle_executable *g:ale_java_checkstyle_executable* *b:ale_java_checkstyle_executable* Type: |String| - Default: 'checkstyle' + Default: `'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* *b:ale_java_pmd_options* - Type: String - Default: '-R category/java/bestpractices' + Type: |String| + Default: `'-R category/java/bestpractices'` This variable can be changed to modify flags given to PMD. Do not specify -f and -d. They are added automatically. diff --git a/doc/ale-julia.txt b/doc/ale-julia.txt index 51532419..ab74ee12 100644 --- a/doc/ale-julia.txt +++ b/doc/ale-julia.txt @@ -11,7 +11,7 @@ g:ale_julia_executable *g:ale_julia_executable* *b:ale_julia_executable* Type: |String| - Default: 'julia' + Default: `'julia'` Path to the julia exetuable. diff --git a/doc/ale-kotlin.txt b/doc/ale-kotlin.txt index 4028531f..87cf56c5 100644 --- a/doc/ale-kotlin.txt +++ b/doc/ale-kotlin.txt @@ -79,7 +79,7 @@ g:ale_kotlin_ktlint_executable *g:ale_kotlin_ktlint_executable* g:ale_kotlin_ktlint_rulesets *g:ale_kotlin_ktlint_rulesets* Type: |List| of |String|s - Default: [] + Default: `[]` This list should contain paths to ruleset jars and/or strings of maven artifact triples. Example: diff --git a/doc/ale-llvm.txt b/doc/ale-llvm.txt index 2f4a46bd..fff1c305 100644 --- a/doc/ale-llvm.txt +++ b/doc/ale-llvm.txt @@ -9,7 +9,7 @@ g:ale_llvm_llc_executable *g:ale_llvm_llc_executable* *b:ale_llvm_llc_executable* Type: |String| - Default: "llc" + Default: `"llc"` The command to use for checking. This variable is useful when llc command has suffix like "llc-5.0". diff --git a/doc/ale-perl.txt b/doc/ale-perl.txt index 761c2735..5eebc0e3 100644 --- a/doc/ale-perl.txt +++ b/doc/ale-perl.txt @@ -72,7 +72,7 @@ g:ale_perl_perlcritic_options *g:ale_perl_perlcritic_options* g:ale_perl_perlcritic_showrules *g:ale_perl_perlcritic_showrules* Type: |Number| - Default: 0 + Default: `0` Controls whether perlcritic rule names are shown after the error message. Defaults to off to reduce length of message. diff --git a/doc/ale-powershell.txt b/doc/ale-powershell.txt index 46bc6cfb..44a3c618 100644 --- a/doc/ale-powershell.txt +++ b/doc/ale-powershell.txt @@ -13,7 +13,7 @@ powershell *ale-powershell-powershell* g:ale_powershell_powershell_executable *g:ale_powershell_powershell_executable* *b:ale_powershell_powershell_executable* - Type: String + Type: |String| Default: `'pwsh'` This variable can be changed to use a different executable for powershell. diff --git a/doc/ale-proto.txt b/doc/ale-proto.txt index a1bf1303..198ae3b6 100644 --- a/doc/ale-proto.txt +++ b/doc/ale-proto.txt @@ -25,7 +25,7 @@ buf-format *ale-proto-buf-format* g:ale_proto_buf_format_executable *g:ale_proto_buf_format_executable* Type: |String| - Default: 'buf' + Default: `'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* Type: |String| - Default: 'buf' + Default: `'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* Type: |String| - Default: 'protolint' + Default: `'protolint'` This variable can be changed to modify the executable used for protolint. diff --git a/doc/ale-purescript.txt b/doc/ale-purescript.txt index 91bef558..25b3dd8d 100644 --- a/doc/ale-purescript.txt +++ b/doc/ale-purescript.txt @@ -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* *b:ale_purescript_tidy_options* - Type: String + Type: |String| Default: `''` This variable can be set to pass in additional option to the 'purs-tidy' diff --git a/doc/ale-ruby.txt b/doc/ale-ruby.txt index bd7bd57d..b0773fdd 100644 --- a/doc/ale-ruby.txt +++ b/doc/ale-ruby.txt @@ -7,7 +7,7 @@ brakeman *ale-ruby-brakeman* g:ale_ruby_brakeman_executable *g:ale_ruby_brakeman_executable* *b:ale_ruby_brakeman_executable* - Type: String + Type: |String| Default: `'brakeman'` 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* *b:ale_ruby_debride_executable* - Type: String + Type: |String| Default: `'debride'` 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* *b:ale_ruby_rails_best_practices_executable* - Type: String + Type: |String| Default: `'rails_best_practices'` 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* *b:ale_ruby_reek_executable* - Type: String + Type: |String| Default: `'reek'` 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* *b:ale_ruby_reek_show_context* Type: |Number| - Default: 0 + Default: `0` Controls whether context is included in the linter message. Defaults to off 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* *b:ale_ruby_reek_show_wiki_link* Type: |Number| - Default: 0 + Default: `0` Controls whether linter messages contain a link to an explanatory wiki page 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* *b:ale_ruby_rubocop_executable* - Type: String + Type: |String| Default: `'rubocop'` 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* *b:ale_ruby_rubocop_auto_correct_all* - Type: Number + Type: |Number| Default: `0` 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* *b:ale_ruby_ruby_executable* - Type: String + Type: |String| Default: `'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* *b:ale_ruby_rufo_executable* - Type: String + Type: |String| Default: `'rufo'` 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* *b:ale_ruby_solargraph_executable* - Type: String + Type: |String| Default: `'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* *b:ale_ruby_sorbet_executable* - Type: String + Type: |String| Default: `'srb'` 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* *b:ale_ruby_standardrb_executable* - Type: String + Type: |String| Default: `'standardrb'` 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* *b:ale_ruby_syntax_tree_executable* - Type: String + Type: |String| Default: `'stree'` Override the invoked SyntaxTree binary. Set this to `'bundle'` to invoke diff --git a/doc/ale-rust.txt b/doc/ale-rust.txt index c8ec9b13..ceef12e3 100644 --- a/doc/ale-rust.txt +++ b/doc/ale-rust.txt @@ -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* *b:ale_rust_ignore_secondary_spans* - Type: Number - Default: 0 + Type: |Number| + Default: `0` 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 diff --git a/doc/ale-tex.txt b/doc/ale-tex.txt index 147aacc4..fa0d827e 100644 --- a/doc/ale-tex.txt +++ b/doc/ale-tex.txt @@ -33,7 +33,7 @@ lacheck *ale-tex-lacheck* g:ale_lacheck_executable *g:ale_lacheck_executable* *b:ale_lacheck_executable* Type: |String| - Default: '`lacheck`' + Default: `'lacheck'` This variable can be changed to change the path to lacheck. diff --git a/doc/ale-xml.txt b/doc/ale-xml.txt index e43fdefd..a7180df8 100644 --- a/doc/ale-xml.txt +++ b/doc/ale-xml.txt @@ -24,7 +24,7 @@ g:ale_xml_xmllint_options *g:ale_xml_xmllint_options* g:ale_xml_xmllint_indentsize *g:ale_xml_xmllint_indentsize* *b:ale_xml_xmllint_indentsize* Type: |Number| - Default: 2 + Default: `2` This variable can be sent to specify the amount of spaces used for indentation. diff --git a/doc/ale.txt b/doc/ale.txt index 10799fe2..f038e95f 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -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* |