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

Add briefer help tags for ALE development documentation

Browse source
This commit is contained in:
w0rp 2019-01-08 14:40:22 +00:00
parent 84475ff6f1
commit f23811770a
No known key found for this signature in database
GPG key ID: 0FC1ECAA8C81CD83
2 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.github/PULL_REQUEST_TEMPLATE.md vendored
View file

@ -2,7 +2,7 @@
Before creating a pull request, do the following. Before creating a pull request, do the following.
* Read the Contributing guide linked above first. * Read the Contributing guide linked above first.
* Read the documentation that comes with ALE with `:help ale-development`. * Read the documentation that comes with ALE with `:help ale-dev`.
Have fun! Have fun!
--> -->
@ -10,4 +10,4 @@ Have fun!
Where are the tests? Have you added tests? Have you updated the tests? Read the Where are the tests? Have you added tests? Have you updated the tests? Read the
comment above and the documentation referenced in it first. Write tests! comment above and the documentation referenced in it first. Write tests!
Seriously, read `:help ale-development` and write tests. Seriously, read `:help ale-dev` and write tests.

3
doc/ale-development.txt
View file

@ -1,4 +1,5 @@
*ale-development.txt* For Vim version 8.0. *ale-development.txt* For Vim version 8.0.
*ale-dev*
*ale-development* *ale-development*
ALE Development Documentation ALE Development Documentation
@ -143,7 +144,7 @@ Apply the following rules when writing Bash scripts.
* Try to write scripts so they will run on Linux, BSD, or Mac OSX. * Try to write scripts so they will run on Linux, BSD, or Mac OSX.
=============================================================================== ===============================================================================
4. Testing ALE *ale-development-tests* 4. Testing ALE *ale-development-tests* *ale-dev-tests* *ale-tests*
ALE is tested with a suite of tests executed in Travis CI and AppVeyor. ALE ALE is tested with a suite of tests executed in Travis CI and AppVeyor. ALE
runs tests with the following versions of Vim in the following environments. runs tests with the following versions of Vim in the following environments.