Merge commit '76265755a1add77121c8f9dabb3e9bb70fe9a972' as '.vim/bundle/ale'

[etc/vim.git] / .vim / bundle / ale / doc / ale-r.txt

diff --git a/.vim/bundle/ale/doc/ale-r.txt b/.vim/bundle/ale/doc/ale-r.txt
new file mode 100644 (file)
index 0000000..3610500
--- /dev/null
+++ b/.vim/bundle/ale/doc/ale-r.txt
@@ -0,0 +1,81 @@
+===============================================================================
+ALE R Integration                                               *ale-r-options*
+
+
+===============================================================================
+languageserver                                           *ale-r-languageserver*
+
+                                             *ale-options.r_languageserver_cmd*
+                                                   *g:ale_r_languageserver_cmd*
+                                                   *b:ale_r_languageserver_cmd*
+r_languageserver_cmd
+g:ale_r_languageserver_cmd
+  Type: |String|
+  Default: `'languageserver::run()'`
+
+  This option can be configured to change the execution command for
+  languageserver.
+
+  See the languageserver documentation for more options.
+
+                                          *ale-options.r_languageserver_config*
+                                                *g:ale_r_languageserver_config*
+                                                *b:ale_r_languageserver_config*
+r_languageserver_config
+g:ale_r_languageserver_config
+  Type: |Dictionary|
+  Default: `{}`
+
+  This option can be configured to change settings for languageserver. See the
+  languageserver documentation for more information.
+
+
+===============================================================================
+lintr                                                             *ale-r-lintr*
+
+                                                  *ale-options.r_lintr_options*
+                                                        *g:ale_r_lintr_options*
+                                                        *b:ale_r_lintr_options*
+r_lintr_options
+g:ale_r_lintr_options
+  Type: |String|
+  Default: `'lintr::with_defaults()'`
+
+  This option can be configured to change the options for lintr.
+
+  The value of this option will be run with `eval` for the `lintr::lint`
+  options. Consult the lintr documentation for more information.
+
+                                             *ale-options.r_lintr_lint_package*
+                                                   *g:ale_r_lintr_lint_package*
+                                                   *b:ale_r_lintr_lint_package*
+r_lintr_lint_package
+g:ale_r_lintr_lint_package
+  Type: |Number|
+  Default: `0`
+
+  When set to `1`, the file will be checked with `lintr::lint_package` instead
+  of `lintr::lint`. This prevents erroneous namespace warnings when linting
+  package files.
+
+
+===============================================================================
+styler                                                           *ale-r-styler*
+
+                                                 *ale-options.r_styler_options*
+                                                       *g:ale_r_styler_options*
+                                                       *b:ale_r_styler_options*
+r_styler_options
+g:ale_r_styler_options
+  Type: |String|
+  Default: `'styler::tidyverse_style'`
+
+  This option can be configured to change the options for styler.
+
+  The value of this option will be used as the `style` argument for the
+  `styler::style_file` options. Consult the styler documentation
+  for more information.
+
+
+===============================================================================
+  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: