Debian Codegraph @

docs/TODO

raw
1 Background
2 ----------
3
4 [brain dump]
5
6 The "Old Cython Users Guide" is a derivative of the old Pyrex documentation.
7 It underwent substantial editing by Peter Alexandar
8 to become the Reference Guide, which is oriented around bullet points
9 and lists rather than prose. This transition was incomplete.
10
11 At nearly the same time, Robert, Dag, and Stefan wrote a tutorial as
12 part of the SciPy proceedings. It was felt that the content there was
13 cleaner and more up to date than anything else, and this became the
14 basis for the "Getting Started" and "Tutorials" sections. However,
15 it simply doesn't have as much content as the old documentation used to.
16 Eventually, it seems all of the old users manual could be whittled
17 down into independent tutorial topics. Much discussion of what we'd
18 like to see is at
19
20 https://www.mail-archive.com/[email protected]/msg06945.html
21
22 There is currently a huge amount of redundancy, but no one section has
23 it all.
24
25 Also, we should go through the wiki enhancement proposal list
26 and make sure to transfer the (done) ones into the user manual.