Commit 6009ccf9 authored by scoder's avatar scoder Committed by GitHub

Merge pull request #2081 from chris-b1/directive-docs

Add warnings to compiler directive docs
parents a4398a4e 07968d8d
...@@ -588,6 +588,37 @@ Configurable optimisations ...@@ -588,6 +588,37 @@ Configurable optimisations
completely wrong. completely wrong.
Disabling this option can also reduce the code size. Default is True. Disabling this option can also reduce the code size. Default is True.
Warnings
--------
All warning directives take True / False as options
to turn the warning on / off.
``warn.undeclared`` (default False)
Warns about any variables that are implicitly declared without a ``cdef`` declaration
``warn.unreachable`` (default True)
Warns about code paths that are statically determined to be unreachable, e.g.
returning twice unconditionally.
``warn.maybe_uninitialized`` (default False)
Warns about use of variables that are conditionally uninitialized.
``warn.unused`` (default False)
Warns about unused variables and declarations
``warn.unused_arg`` (default False)
Warns about unused function arguments
``warn.unused_result`` (default False)
Warns about unused assignment to the same name, such as
``r = 2; r = 1 + 2``
``warn.multiple_declarators`` (default True)
Warns about multiple variables declared on the same line with at least one pointer type.
For example ``cdef double* a, b`` - which, as in C, declares ``a`` as a pointer, ``b`` as
a value type, but could be mininterpreted as declaring two pointers.
How to set directives How to set directives
--------------------- ---------------------
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment