marc/ale
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Complain about badly aligned documentation on Travis CI, and fix some existing problems

Browse source
This commit is contained in:
w0rp 2017-08-30 21:56:43 +01:00
parent 688212130d
commit fca77266bd
4 changed files with 26 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/ale-awk.txt
View file

@ -1,20 +1,20 @@
===============================================================================
ALE Awk Integration *ale-awk-options*
ALE Awk Integration *ale-awk-options*
===============================================================================
gawk *ale-awk-gawk*
gawk *ale-awk-gawk*
g:ale_awk_gawk_executable *g:ale_awk_gawk_executable*
*b:ale_awk_gawk_executable*
g:ale_awk_gawk_executable *g:ale_awk_gawk_executable*
*b:ale_awk_gawk_executable*
Type: |String|
Default: `'gawk'`
This variable sets executable used for gawk.
g:ale_awk_gawk_options *g:ale_awk_gawk_options*
*b:ale_awk_gawk_options*
g:ale_awk_gawk_options *g:ale_awk_gawk_options*
*b:ale_awk_gawk_options*
Type: |String|
Default: `''`

4
doc/ale-css.txt
View file

@ -13,8 +13,8 @@ g:ale_css_stylelint_executable *g:ale_css_stylelint_executable*
See |ale-integrations-local-executables|
g:ale_css_stylelint_options *g:ale_css_stylelint_options*
*b:ale_css_stylelint_options*
g:ale_css_stylelint_options *g:ale_css_stylelint_options*
*b:ale_css_stylelint_options*
Type: |String|
Default: `''`

12
doc/ale-xml.txt
View file

@ -1,20 +1,20 @@
===============================================================================
ALE XML Integration *ale-xml-options*
ALE XML Integration *ale-xml-options*
===============================================================================
xmllint *ale-xml-xmllint*
xmllint *ale-xml-xmllint*
g:ale_xml_xmllint_executable *g:ale_xml_xmllint_executable*
*b:ale_xml_xmllint_executable*
g:ale_xml_xmllint_executable *g:ale_xml_xmllint_executable*
*b:ale_xml_xmllint_executable*
Type: |String|
Default: `'xmllint'`
This variable can be set to change the path to xmllint.
g:ale_xml_xmllint_options *g:ale_xml_xmllint_options*
*b:ale_xml_xmllint_options*
g:ale_xml_xmllint_options *g:ale_xml_xmllint_options*
*b:ale_xml_xmllint_options*
Type: |String|
Default: `''`

12
run-tests
View file

@ -243,6 +243,18 @@ if ((run_custom_checks)); then
echo
./check-supported-tools-tables || EXIT=$?
echo '========================================'
echo 'Look for badly aligned doc tags'
echo '========================================'
echo 'Badly aligned tags follow:'
echo
# Documentation tags need to be aligned to the right margin, so look for
# tags which aren't at the right margin.
grep ' \*[^*]\+\*$' doc/ -r \
| awk '{ sep = index($0, ":"); if (length(substr($0, sep + 1 )) < 79) { print } }' \
| grep . && EXIT=1
fi
exit $EXIT