Commit eb39c410 authored by Gabriel Gellner's avatar Gabriel Gellner

Fixed TODO: comments in some files. Added documentation TODO.

parent 7f20eee9
* 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.
...@@ -159,7 +159,18 @@ header file, and the corresponding Cython declaration that you should put in ...@@ -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 the ``cdef extern`` from block. Struct declarations are used as an example; the
same applies equally to union and enum declarations. 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 Note that in all the cases below, you refer to the type in Cython code simply
as :ctype:`Foo`, not ``struct Foo``. as :ctype:`Foo`, not ``struct Foo``.
......
...@@ -267,7 +267,7 @@ Synonyms ...@@ -267,7 +267,7 @@ Synonyms
Source code encoding 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 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. file with an encoding comment and generally write your source code in UTF-8.
......
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