From: Robert Bradshaw <robertwb@math.washington.edu>
Date: Thu, 12 Nov 2009 08:21:12 +0000 (-0800)
Subject: Add todo.txt with some background.
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=6f24ed3e123bb562a46601eaace8a25ff87ec901;p=cython.git

Add todo.txt with some background.
---

diff --git a/todo.txt b/todo.txt
new file mode 100644
index 00000000..2c53f42f
--- /dev/null
+++ b/todo.txt
@@ -0,0 +1,24 @@
+Background
+----------
+
+[brain dump]
+
+The "Old Cython Users Guide" is a derivative of the old Pyrex documentation. It underwent substantial editing by Peter Alexandar
+to become the Reference Guide, which is oriented around bullet points
+and lists rather than prose. This transition was incomplete. 
+
+At nearly the same time, Robert, Dag, and Stefan wrote a tutorial as 
+part of the SciPy proceedings. It was felt that the content there was 
+cleaner and more up to date than anything else, and this became the 
+basis for the "Getting Started" and "Tutorials" sections. However, 
+it simply doesn't have as much content as the old documentation used to. 
+Eventually, it seems all of the old users manual could be whittled
+down into independent tutorial topics. Much discussion of what we'd
+like to see is at 
+
+http://www.mail-archive.com/cython-dev@codespeak.net/msg06945.html
+
+There is currently a huge amount of redundancy, but no one section has 
+it all. 
+
+Also, we should go through the wiki enhancement proposal list and make sure to transfer the (done) ones into the user manual.