summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2017-09-03 23:36:58 +0100
committerw0rp <devw0rp@gmail.com>2017-09-03 23:36:58 +0100
commit984c4f06587a1519eeaef48c813b44cdbb5f7b1f (patch)
tree14ff428fb5d1fd03e966beb34818928615486243 /doc
parent1ea5400e8d26c1ebb99912cace5faaffa8c270bf (diff)
downloadale-984c4f06587a1519eeaef48c813b44cdbb5f7b1f.zip
Document the new lintr option
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-r.txt20
-rw-r--r--doc/ale.txt2
2 files changed, 22 insertions, 0 deletions
diff --git a/doc/ale-r.txt b/doc/ale-r.txt
new file mode 100644
index 00000000..6372f80d
--- /dev/null
+++ b/doc/ale-r.txt
@@ -0,0 +1,20 @@
+===============================================================================
+ALE R Integration *ale-r-options*
+
+
+===============================================================================
+lintr *ale-r-lintr*
+
+g:ale_r_lintr_options *g:ale_r_lintr_options*
+ *b: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.
+
+
+===============================================================================
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale.txt b/doc/ale.txt
index 70f90cc3..899e8c80 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -101,6 +101,8 @@ CONTENTS *ale-contents*
pycodestyle.........................|ale-python-pycodestyle|
pylint..............................|ale-python-pylint|
yapf................................|ale-python-yapf|
+ r.....................................|ale-r-options|
+ lintr...............................|ale-r-lintr|
ruby..................................|ale-ruby-options|
brakeman............................|ale-ruby-brakeman|
rails_best_practices................|ale-ruby-rails_best_practices|