[Cython] Documentation

[Robert Bradshaw]

On Sep 27, 2008, at 7:49 AM, Gabriel Gellner wrote:

> Well seeing the need I am writing up a tutorial for simple  
> compilation and
> usage for my Sphinx docs. This leads me to update some of the other  
> pages to
> reflect recent changes, and I would like some feedback to ensure I  
> understand
> everything!
>
> * CEP 106 (Package pxds): should I update the wiki (and add to the  
> docs) that we have a bunch
>            of basic .pxd's now? Or are we waiting for something?

Yep, this is done.

> * CEP 301 (from blah import *): says DONE, is this true in the  
> released
>     version, it seems to work for me using the PyPI version, but I  
> never use
>     this feature, so I don't know if I am missing something.

This is nearly done, short of this bug http://trac.cython.org/ 
cython_trac/ticket/73

> * CEP 302 (with statement): again status is DONE, again seems to  
> work for me,
>     but the wiki still says this is a limitation, is there a go  
> ahead to
>     remove this from the limitation wiki?

Yep, done.

> Finally is the current wiki state describing the differences  
> between Cython
> and Pyrex true? It seems Pyrex has done a lot of updating, and that  
> it has
> some features know that Cython doesn't (I am thinking of the h5py  
> code,
> something about type checking ... I haven't really been following).  
> If anyone
> has knowledge of this could they give the wiki page a once over, I  
> would then
> make the changes to the Sphinx docs.


I did a quick pass on that page to get it (more) up to date. I am  
sure there's stuff in Cython not in Pyrex not on that page, but I've  
removed the things that Pyrex caught up on.


On Sep 27, 2008, at 7:59 AM, Gabriel Gellner wrote:
> Also is the following points still all True?
>
> * The :func:``globals`` and :func:``locals`` functions cannot be used.

Yes.

> * Class and function definitions cannot be placed inside control  
> structures.

Unfortunately...

> * There is no support for Unicode. # I believe this isn't  
> true . . . definitive answer?

I believe we support it fully now, but Stefan would be able to give  
the definitive answer.

> * Special methods of extension types cannot have functioning  
> docstrings.

They can now.

> * The use of string literals as comments is not recommended at  
> present,
>   because Cython doesn't optimize them away, and won't even accept  
> them in
>   places where executable statements are not allowed.

They can now.



On Sep 27, 2008, at 8:03 AM, Gabriel Gellner wrote:
> At
> http://wiki.cython.org/Unsupported
>
> optimized support for builtin types is listed, shouldn't this be in  
> a CEP
> instead? It is not really an unsupported python feature, just not a  
> perfectly
> implemented feature . . .

True, but they're supported now.

> Also should I add a quick line that function closures are not  
> supported, so
> that all the other pages that list this as needed are more complete?

I updated http://wiki.cython.org/Unsupported with these points (and  
those above).

Thanks again for putting this together.

- Robert