From eb39c410e785a3fb1bfbcbed335ddd527c6a9849 Mon Sep 17 00:00:00 2001 From: Gabriel Gellner Date: Sun, 4 May 2008 14:13:53 -0400 Subject: [PATCH] Fixed TODO: comments in some files. Added documentation TODO. --- TODO | 10 ++++++++++ docs/external_C_code.rst | 13 ++++++++++++- docs/pyrex_differences.rst | 2 +- 3 files changed, 23 insertions(+), 2 deletions(-) create mode 100644 TODO diff --git a/TODO b/TODO new file mode 100644 index 00000000..4958cc06 --- /dev/null +++ b/TODO @@ -0,0 +1,10 @@ +* Make a Pygments lexer for cython/pyrex so we get nice color coding. +* Fix up the latex style file so that boxes are not messed up when we have + code examples. +* Put on my writing hat, and do an overhaul of the structure of the docs so + that it is faster to navigate. I will be using the python doc structure as a + reference. +* Get some simple howto's written. +* Thinking if there is an easy way to test the cython code in the docs so that + I can ensure accuracy. + diff --git a/docs/external_C_code.rst b/docs/external_C_code.rst index 2fb06675..d6cebb06 100644 --- a/docs/external_C_code.rst +++ b/docs/external_C_code.rst @@ -159,7 +159,18 @@ header file, and the corresponding Cython declaration that you should put in the ``cdef extern`` from block. Struct declarations are used as an example; the same applies equally to union and enum declarations. --- TODO: put table here... +.. TODO: put table here... + ++-----------------+--------------------+ +| C code | Cython | ++-----------------+--------------------+ +| :: | :: | +| | | +| struct Foo { | cdef struct Foo: | +| ... | ... | +| }; | | ++-----------------+--------------------+ + Note that in all the cases below, you refer to the type in Cython code simply as :ctype:`Foo`, not ``struct Foo``. diff --git a/docs/pyrex_differences.rst b/docs/pyrex_differences.rst index decd761d..20cb7371 100644 --- a/docs/pyrex_differences.rst +++ b/docs/pyrex_differences.rst @@ -267,7 +267,7 @@ Synonyms Source code encoding -------------------- --- TODO: add the links to the relevent PEPs +.. TODO: add the links to the relevent PEPs Cython supports PEP 3120 and PEP 263, i.e. you can start your Cython source file with an encoding comment and generally write your source code in UTF-8. -- 2.26.2