summaryrefslogtreecommitdiff
path: root/doc/ale-r.txt
diff options
context:
space:
mode:
authorThibault Vatter <thibault.vatter@gmail.com>2019-04-23 14:44:26 -0400
committerw0rp <w0rp@users.noreply.github.com>2019-04-23 19:44:26 +0100
commitce0b14979ea7429f07b6ca496333f72d93a8d013 (patch)
tree337a94162284dac87f87e155a27e5837ec3435ea /doc/ale-r.txt
parent893ac34cca903df14dabee7bdee7a018675c16d4 (diff)
downloadale-ce0b14979ea7429f07b6ca496333f72d93a8d013.zip
Add a fixer for r based on the styler package (#2401)
* Add styler as a new fixer for R files * Add to the list of supported tools * Add documentation
Diffstat (limited to 'doc/ale-r.txt')
-rw-r--r--doc/ale-r.txt16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/ale-r.txt b/doc/ale-r.txt
index f85f48fd..b5ccebe5 100644
--- a/doc/ale-r.txt
+++ b/doc/ale-r.txt
@@ -25,5 +25,21 @@ g:ale_r_lintr_lint_package *g:ale_r_lintr_lint_package*
of `lintr::lint`. This prevents erroneous namespace warnings when linting
package files.
+
+===============================================================================
+styler *ale-r-styler*
+
+g:ale_r_styler_options *g:ale_r_styler_options*
+ *b: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: