Right now, there are two files containing information about the c++
mode of cython. One in the user guide
(http://docs.cython.org/src/userguide/wrapping_CPlusPlus.html), and
another one in the wiki (http://wiki.cython.org/WrappingCPlusPlus).
Note that googling for "cython c++" brings you to the wiki page.

I think that, historically, the wiki file contained the tips and
tricks to write c++ code with cython/pyrex versions <=0.12. It was
then modified to include infos about the new c++ mode of cython0.13 .
The userguide file seems to have started as a copy of the wiki file
but has been edited separately, so that the two files are out of sync.
For example, the user guide file miss infos about nested classes
syntax and cython.operator.dereference. The wiki file show an example
of nested class declaration, but with the wrong syntax.

Considering that :
(1) -  It seems a lot of duplicate effort to maintain two doc files
about the same features.
(2) - The old version of the wiki file would still be useful for
people who can't upgrade to cython0.13, or have to maintain older
code.

, I propose to do the following:
1- Reverse http://wiki.cython.org/WrappingCPlusPlus to the version for
cython<=0.12
2- Maybe rename it to WrappingCPlusPlus_ForCython012AndLower
3- Add a big warning on top of WrappingCPlusPlus_ForCython012AndLower
saying that "This information is deprecated. Starting with version
0.13, cython has full native support for c++. See section xxx of the
user guide for details"
4- Add all the missing information that was contained in the wiki file
to the userguide file. This include (at least):  nested class
declaration, cython.operator.dereference,
cython.operator.preincrement,  (any other cython.operator I should
know? I suppose there is at least a operator.postincrement ...)

What do you think?
_______________________________________________
Cython-dev mailing list
[email protected]
http://codespeak.net/mailman/listinfo/cython-dev

Reply via email to