summaryrefslogtreecommitdiff
path: root/doc/ale-development.txt
diff options
context:
space:
mode:
authorw0rp <devw0rp@gmail.com>2018-07-12 13:05:59 +0100
committerw0rp <devw0rp@gmail.com>2018-07-12 13:05:59 +0100
commitac0abc7c1fb1150edc4359e1a86c2a22e95de71c (patch)
treeebe0ff7cd658568a35900b0e39bbeaeab6c2d655 /doc/ale-development.txt
parent6ef31073dd8f8d094ef7bc5e7152a576ef4f9064 (diff)
downloadale-ac0abc7c1fb1150edc4359e1a86c2a22e95de71c.zip
Fix #1716 - Replace tempdir() with a wrapper to preserve TMPDIR
Diffstat (limited to 'doc/ale-development.txt')
-rw-r--r--doc/ale-development.txt3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/ale-development.txt b/doc/ale-development.txt
index 841371c7..f97bdee4 100644
--- a/doc/ale-development.txt
+++ b/doc/ale-development.txt
@@ -111,6 +111,9 @@ these are reported with ALE's `custom-linting-rules` script. See
* Don't use the `shellescape()` function. It doesn't escape arguments properly
on Windows. Use `ale#Escape()` instead, which will avoid escaping where it
isn't needed, and generally escape arguments better on Windows.
+* 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.
Apply the following guidelines when writing Vader test files.