summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-java.txt6
-rw-r--r--doc/ale-php.txt18
-rw-r--r--doc/ale.txt12
3 files changed, 18 insertions, 18 deletions
diff --git a/doc/ale-java.txt b/doc/ale-java.txt
index 36d606de..13decb41 100644
--- a/doc/ale-java.txt
+++ b/doc/ale-java.txt
@@ -3,10 +3,10 @@ ALE Java Integration *ale-java-options*
===============================================================================
-checkstyle ale-java-checkstyle
+checkstyle *ale-java-checkstyle*
-g:ale_java_checkstyle_options g:ale_java_checkstyle_options
- b:ale_java_checkstyle_options
+g:ale_java_checkstyle_options *g:ale_java_checkstyle_options*
+ *b:ale_java_checkstyle_options*
Type: String
Default: '-c /google_checks.xml'
diff --git a/doc/ale-php.txt b/doc/ale-php.txt
index c8874106..8865021a 100644
--- a/doc/ale-php.txt
+++ b/doc/ale-php.txt
@@ -11,25 +11,25 @@ There are no options for this linter.
===============================================================================
langserver *ale-php-langserver*
-g:php_langserver_executable *g:php_langserver_executable*
- *b:php_langserver_executable*
+g:ale_php_langserver_executable *g:ale_php_langserver_executable*
+ *b:ale_php_langserver_executable*
Type: |String|
Default: `'php-language-server.php'`
The variable can be set to configure the executable that will be used for
running the PHP language server. `vendor` directory executables will be
- preferred instead of this setting if |g:php_langserver_use_global| is `0`.
+ preferred instead of this setting if |g:ale_php_langserver_use_global| is `0`.
See: |ale-integrations-local-executables|
-g:php_langserver_use_global *g:php_langserver_use_global*
- *b:php_langserver_use_global*
+g:ale_php_langserver_use_global *g:ale_php_langserver_use_global*
+ *b:ale_php_langserver_use_global*
Type: |Number|
Default: `0`
This variable can be set to `1` to force the language server to be run with
- the executable set for |g:php_langserver_executable|.
+ the executable set for |g:ale_php_langserver_executable|.
See: |ale-integrations-local-executables|
@@ -63,7 +63,7 @@ g:ale_php_phpcs_use_global *g:ale_php_phpcs_use_global*
See |ale-integrations-local-executables|
-------------------------------------------------------------------------------
+-------------------------------------------------------------------------------
phpmd *ale-php-phpmd*
g:ale_php_phpmd_ruleset *g:ale_php_phpmd_ruleset*
@@ -75,8 +75,8 @@ g:ale_php_phpmd_ruleset *g:ale_php_phpmd_ruleset*
the available phpmd rulesets
-------------------------------------------------------------------------------
-phpstan *ale-php-stan*
+-------------------------------------------------------------------------------
+phpstan *ale-php-phpstan*
g:ale_php_phpstan_executable *g:ale_php_phpstan_executable*
*b:ale_php_phpstan_executable*
diff --git a/doc/ale.txt b/doc/ale.txt
index f5a51359..869a5576 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -204,7 +204,7 @@ The following languages and tools are supported.
* nroff: 'proselint'
* Objective-C: 'clang'
* Objective-C++: 'clang'
-* OCaml: 'merlin' (see |ale-linter-integration-ocaml-merlin|)
+* OCaml: 'merlin' (see |ale-ocaml-merlin|)
* Perl: 'perl' (-c flag), 'perlcritic'
* PHP: 'hack', 'langserver', 'php' (-l flag), 'phpcs', 'phpmd', 'phpstan'
* Pod: 'proselint'
@@ -287,8 +287,8 @@ g:ale_echo_msg_error_str *g:ale_echo_msg_error_str*
Default: `Error`
The string used for error severity in the echoed message.
- Note |`g:ale_echo_cursor`| should be set to 1
- Note |`g:ale_echo_msg_format`| should contain the `%severity%` handler
+ Note |g:ale_echo_cursor| should be set to 1
+ Note |g:ale_echo_msg_format| should contain the `%severity%` handler
g:ale_echo_msg_format *g:ale_echo_msg_format*
@@ -300,7 +300,7 @@ g:ale_echo_msg_format *g:ale_echo_msg_format*
error message itself, and it can contain the following handlers:
- `%linter%` for linter's name
- `%severity%` for the type of severity
- Note |`g:ale_echo_cursor`| should be setted to 1
+ Note |g:ale_echo_cursor| should be setted to 1
g:ale_echo_msg_warning_str *g:ale_echo_msg_warning_str*
@@ -309,8 +309,8 @@ g:ale_echo_msg_warning_str *g:ale_echo_msg_warning_str*
Default: `Warning`
The string used for warning severity in the echoed message.
- Note |`g:ale_echo_cursor`| should be set to 1
- Note |`g:ale_echo_msg_format`| should contain the `%severity%` handler
+ Note |g:ale_echo_cursor| should be set to 1
+ Note |g:ale_echo_msg_format| should contain the `%severity%` handler
g:ale_emit_conflict_warnings *g:ale_emit_conflict_warnings*