Overflow check docs.
authorRobert Bradshaw <robertwb@gmail.com>
Thu, 25 Oct 2012 07:17:22 +0000 (00:17 -0700)
committerRobert Bradshaw <robertwb@gmail.com>
Thu, 25 Oct 2012 07:17:22 +0000 (00:17 -0700)
docs/src/reference/compilation.rst

index be2a3c6..6a7c4dc 100644 (file)
@@ -148,6 +148,11 @@ Cython code.  Here is the list of currently supported directives:
     set to ``None``. Otherwise a check is inserted and the
     appropriate exception is raised. This is off by default for
     performance reasons.  Default is False.
+    
+``overflowcheck`` (True / False)
+    If set to True, raise errors on overflowing C integer arithmetic
+    operations.  Incurs a slight runtime penalty, but much faster than
+    using Python ints.  Default is False.
 
 ``embedsignature`` (True / False)
     If set to True, Cython will embed a textual copy of the call