Skip to content

Commit

Permalink
Add briefer help tags for ALE development documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
w0rp committed Jan 8, 2019
1 parent 84475ff commit f238117
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
Before creating a pull request, do the following.
* 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!
-->

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!

Seriously, read `:help ale-development` and write tests.
Seriously, read `:help ale-dev` and write tests.
3 changes: 2 additions & 1 deletion doc/ale-development.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
*ale-development.txt* For Vim version 8.0.
*ale-dev*
*ale-development*

ALE Development Documentation
Expand Down Expand Up @@ -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.

===============================================================================
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
runs tests with the following versions of Vim in the following environments.
Expand Down

0 comments on commit f238117

Please sign in to comment.