summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <w0rp@users.noreply.github.com>2016-10-07 07:34:24 +0100
committerGitHub <noreply@github.com>2016-10-07 07:34:24 +0100
commit983485bc14c838d5b6e02bef0feb1fdb38849413 (patch)
treef30e5096c70ed46ca3d3ce605ce31fdcd41252cc /doc
parentc5d3cc5bc7e7d31834b58c0422cd9fe4c5b616a2 (diff)
parenta14790f6ca77feed07c1377b8539b16b31bde124 (diff)
downloadale-983485bc14c838d5b6e02bef0feb1fdb38849413.zip
Merge pull request #57 from jwilliams108/linter-phpcs
updating config option format and adding to doc
Diffstat (limited to 'doc')
-rw-r--r--doc/ale.txt13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/ale.txt b/doc/ale.txt
index b428d6d8..8914ec83 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -11,6 +11,7 @@ CONTENTS *ale-contents*
3. Global Options.................................|ale-options|
4. Linter Specific Options........................|ale-linter-options|
4.1. eslint................................ ....|ale-linter-options-eslint|
+ 4.2. phpcs......................................|ale-linter-options-phpcs|
5. API............................................|ale-api|
6. Contact........................................|ale-contact|
@@ -236,6 +237,18 @@ Default: `'eslint'`
This variable can be changed to change the path to eslint. If you have
eslint_d installed, you can set this option to use eslint_d instead.
+-------------------------------------------------------------------------------
+4.2. phpcs *ale-linter-options-phpcs*
+
+g:ale_php_phpcs_standard *g:ale_php_phpcs_standard*
+
+Type: |String|
+Default: `''`
+
+This variable can be set to specify the coding standard used by phpcs. If
+no coding standard is specified, phpcs will default to checking against the
+PEAR coding standard, or the standard you have set as the default.
+
===============================================================================
5. API *ale-api*