summaryrefslogtreecommitdiff
path: root/doc/ale-ruby.txt
diff options
context:
space:
mode:
authorEddie Lebow <elebow@users.noreply.github.com>2017-04-20 02:37:08 -0400
committerw0rp <w0rp@users.noreply.github.com>2017-04-20 07:37:08 +0100
commit0384cabd77e38f9a04ff1c8832f6b755855e909e (patch)
tree502e93f9a0f30dc47a932ac316a4879d464272c0 /doc/ale-ruby.txt
parentc6ef9e28a50f2378568c4c35a5346b495cb15c34 (diff)
downloadale-0384cabd77e38f9a04ff1c8832f6b755855e909e.zip
Add the Reek checker for Ruby. (#490)
Add the Reek checker for Ruby.
Diffstat (limited to 'doc/ale-ruby.txt')
-rw-r--r--doc/ale-ruby.txt21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/ale-ruby.txt b/doc/ale-ruby.txt
index 77ea7342..033da360 100644
--- a/doc/ale-ruby.txt
+++ b/doc/ale-ruby.txt
@@ -3,6 +3,27 @@ ALE Ruby Integration *ale-ruby-options*
-------------------------------------------------------------------------------
+reek *ale-ruby-reek*
+
+g:ale_ruby_reek_show_context *g:ale_ruby_reek_show_context*
+
+ Type: |Number|
+ Default: 0
+
+ Controls whether context is included in the linter message. Defaults to off
+ because context is usually obvious while viewing a file.
+
+
+g:ale_ruby_reek_show_wiki_link *g:ale_ruby_reek_show_wiki_link*
+
+ Type: |Number|
+ 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.
+
+
+-------------------------------------------------------------------------------
rubocop *ale-ruby-rubocop*
g:ale_ruby_rubocop_options *g:ale_ruby_rubocop_options*