summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <w0rp@users.noreply.github.com>2018-06-27 21:39:36 +0100
committerGitHub <noreply@github.com>2018-06-27 21:39:36 +0100
commit980aa35566f1a5c66c7b9939bb07ec68deebccb2 (patch)
tree0639cd27bfd5a562de4a69e4e06b415be846ac63 /doc
parentb047271051d8ef448bf4bac120234205310b232a (diff)
parent4d935ff32a1ac8618c8afbf3104cf1864f633300 (diff)
downloadale-980aa35566f1a5c66c7b9939bb07ec68deebccb2.zip
Merge pull request #1675 from nicopauss/master
Improve pyrex cython linter.
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-pyrex.txt25
-rw-r--r--doc/ale.txt2
2 files changed, 27 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:
diff --git a/doc/ale.txt b/doc/ale.txt
index 6c0b3ccf..a24098f3 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -185,6 +185,8 @@ CONTENTS *ale-contents*
puglint.............................|ale-pug-puglint|
puppet................................|ale-puppet-options|
puppetlint..........................|ale-puppet-puppetlint|
+ pyrex (cython)........................|ale-pyrex-options|
+ cython..............................|ale-pyrex-cython|
python................................|ale-python-options|
autopep8............................|ale-python-autopep8|
black...............................|ale-python-black|