summaryrefslogtreecommitdiff
path: root/doc/ale-pyrex.txt
diff options
context:
space:
mode:
authorNicolas Pauss <nicolas.pauss@gmail.com>2018-06-25 09:51:50 +0200
committerNicolas Pauss <nicolas.pauss@intersec.com>2018-06-25 10:28:59 +0200
commitbedd30ee11953bde13856c32a1b8b7a17ef5916a (patch)
treea547624fbe5e9547f751fb01ab873b24f74d93e9 /doc/ale-pyrex.txt
parent620951b6d3420ca69754f3e1068167729d8c651b (diff)
downloadale-bedd30ee11953bde13856c32a1b8b7a17ef5916a.zip
Improve pyrex cython linter.
Like many other linters, use variables for the executable and options used by the linter. By default, the linter now report every warnings as errors with `--warning-errors`. Also add include directory and set working directory to file directory.
Diffstat (limited to 'doc/ale-pyrex.txt')
-rw-r--r--doc/ale-pyrex.txt25
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/ale-pyrex.txt b/doc/ale-pyrex.txt
new file mode 100644
index 00000000..245e611f
--- /dev/null
+++ b/doc/ale-pyrex.txt
@@ -0,0 +1,25 @@
+===============================================================================
+ALE Pyrex (Cython) Integration *ale-pyrex-options*
+
+
+===============================================================================
+cython *ale-pyrex-cython*
+
+g:ale_pyrex_cython_executable *g:ale_pyrex_cython_executable*
+ *b:ale_pyrex_cython_executable*
+ Type: |String|
+ Default: `'cython'`
+
+ This variable can be changed to use a different executable for cython.
+
+
+g:ale_pyrex_cython_options *g:ale_pyrex_cython_options*
+ *b:ale_pyrex_cython_options*
+ Type: |String|
+ Default: `'--warning-extra --warning-errors'`
+
+ This variable can be changed to modify flags given to cython.
+
+
+===============================================================================
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: