summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2017-08-10 10:45:12 +0100
committerw0rp <devw0rp@gmail.com>2017-08-10 10:45:12 +0100
commit9ae2df195865e1f5ce3b1dab8b43c89e59ad471e (patch)
treefc24f64632c5fa0d9f4782cea3949ca09a01ee87 /doc
parent7dee9da0f27c31226a746377ba7f0bda15e70281 (diff)
downloadale-9ae2df195865e1f5ce3b1dab8b43c89e59ad471e.zip
Automatically check for invalid help tag references, and fix some existing documentation issues
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-java.txt6
-rw-r--r--doc/ale-php.txt6
-rw-r--r--doc/ale.txt2
3 files changed, 7 insertions, 7 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 66859888..8865021a 100644
--- a/doc/ale-php.txt
+++ b/doc/ale-php.txt
@@ -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 bb7411ad..56308090 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'