diff options
| author | Stefan Behnel <stefan_ml@behnel.de> | 2018-07-10 18:02:17 +0200 |
|---|---|---|
| committer | Stefan Behnel <stefan_ml@behnel.de> | 2018-08-03 08:29:37 +0200 |
| commit | c332fbb3202d5d83693ec6a8f4305d4d3fc22c6d (patch) | |
| tree | 5ab29902992f80fef9b3c5f162621fb5c501e28c | |
| parent | 60f4080a633ee29a83d008bbff278d73f84c633f (diff) | |
| download | cython-c332fbb3202d5d83693ec6a8f4305d4d3fc22c6d.tar.gz | |
Add docs comment that "verbatim" C code is at least parsed as normal docstring.
Closes #2484.
| -rw-r--r-- | docs/src/userguide/external_C_code.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/src/userguide/external_C_code.rst b/docs/src/userguide/external_C_code.rst index cc8b6c90a..896aae7fe 100644 --- a/docs/src/userguide/external_C_code.rst +++ b/docs/src/userguide/external_C_code.rst @@ -363,6 +363,10 @@ It is also possible to combine a header file and verbatim C code:: In this case, the C code ``#undef int`` is put right after ``#include "badheader.h"`` in the C code generated by Cython. +Note that the string is parsed like any other docstring in Python. +If you require character escapes to be passed into the C code file, +use a raw docstring, i.e. ``r""" ... """``. + Using Cython Declarations from C ================================ |