diff options
| author | w0rp <devw0rp@gmail.com> | 2018-07-24 10:11:14 +0100 |
|---|---|---|
| committer | w0rp <devw0rp@gmail.com> | 2018-07-24 10:11:14 +0100 |
| commit | 341857477011f703664b31d8d76f6872f8399c66 (patch) | |
| tree | 47a9dfca2e0dfbf9f1ff8d3029a9b0b25276bc02 | |
| parent | d368f090aeeca3545dd03b1bfe4bff5e6a95d7e2 (diff) | |
| download | ale-341857477011f703664b31d8d76f6872f8399c66.zip | |
Update the developer documentation
| -rw-r--r-- | doc/ale-development.txt | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/ale-development.txt b/doc/ale-development.txt index 5688c1cc..8a4c1d7d 100644 --- a/doc/ale-development.txt +++ b/doc/ale-development.txt @@ -115,6 +115,9 @@ these are reported with ALE's `custom-linting-rules` script. See * Don't use the `tempname()` function. It doesn't work when `$TMPDIR` isn't set. Use `ale#util#Tempname()` instead, which temporarily sets `$TMPDIR` appropriately where needed. +* Use `snake_case` names for linter names, so they can be used as part of + variable names. You can define `aliases` for linters, for other names people + might try to configure linters with. Apply the following guidelines when writing Vader test files. @@ -145,9 +148,10 @@ 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. 1. Vim 8.0.0027 on Linux via Travis CI. -2. NeoVim 0.2.0 on Linux via Travis CI. -3. NeoVim 0.3.0 on Linux via Travis CI. -4. Vim 8 (stable builds) on Windows via AppVeyor. +2. Vim 8.1.0204 on Linux via Travis CI. +3. NeoVim 0.2.0 on Linux via Travis CI. +4. NeoVim 0.3.0 on Linux via Travis CI. +5. Vim 8 (stable builds) on Windows via AppVeyor. If you are developing ALE code on Linux, Mac OSX, or BSD, you can run ALEs tests by installing Docker and running the `run-tests` script. Follow the |