Fixed TODO: comments in some files. Added documentation TODO.
authorGabriel Gellner <ggellner@uoguelph.ca>
Sun, 4 May 2008 18:13:53 +0000 (14:13 -0400)
committerGabriel Gellner <ggellner@uoguelph.ca>
Sun, 4 May 2008 18:13:53 +0000 (14:13 -0400)
TODO [new file with mode: 0644]
docs/external_C_code.rst
docs/pyrex_differences.rst

diff --git a/TODO b/TODO
new file mode 100644 (file)
index 0000000..4958cc0
--- /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.
+
index 2fb0667555fcff67b5e6d5c5ada831b96dadfdc2..d6cebb0666d810379d9b39c8a49b1f5e73350cc3 100644 (file)
@@ -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``.
index decd761d791334560b72d8a5fd97afbedf7d0d42..20cb737195c541f676d4e8e3c518e2c284f51f52 100644 (file)
@@ -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.