summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorda-woods <dw-git@d-woods.co.uk>2019-11-12 18:54:55 +0000
committerStefan Behnel <stefan_ml@behnel.de>2019-11-12 19:54:55 +0100
commitaf997e97ea926a2e00b740eec61523b0370d98ff (patch)
tree99c48743ef17830ef2d2edec8621f7e2db6a929b
parent64b674f456f2fcde307bdb6145521f1e9e316d93 (diff)
downloadcython-af997e97ea926a2e00b740eec61523b0370d98ff.tar.gz
Documented annotation_typing compiler option (#3232)
-rw-r--r--docs/src/userguide/source_files_and_compilation.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/src/userguide/source_files_and_compilation.rst b/docs/src/userguide/source_files_and_compilation.rst
index d45cb75c6..cdcc91d97 100644
--- a/docs/src/userguide/source_files_and_compilation.rst
+++ b/docs/src/userguide/source_files_and_compilation.rst
@@ -859,6 +859,12 @@ Cython code. Here is the list of currently supported directives:
asyncio before Python 3.5. This directive can be applied in modules or
selectively as decorator on an async-def coroutine to make the affected
coroutine(s) iterable and thus directly interoperable with yield-from.
+
+ ``annotation_typing`` (True / False)
+ Uses function argument annotations to determine the type of variables. Default
+ is True, but can be disabled. Since Python does not enforce types given in
+ annotations, setting to False gives greater compatibility with Python code.
+ Must be set globally.
.. _configurable_optimisations: