[Cython] Comments on Documentation

[Gabriel Gellner]

Thanks for the changes, I will apply them next week (currently getting ready
for a conference ...). If you are feeling ambitious you can try to make a
patch against: 
http://hg.cython.org/cython-docs/

If not don't worry, your email was very clear. Thanks for the help.

Gabriel

On Sat, May 03, 2008 at 03:27:14AM -0400, David Roe wrote:
> Hey guys,
> I saw the post about the documentation at
> http://www.mudskipper.ca/cython-doc/ on sage-devel, and have a few
> typos to point out.  It looks awesome though.
> 
> 1) Indentation problem
> (http://www.mudskipper.ca/cython-doc/docs/extension_types.html):
> 
> cdef Shrubbery another_shrubbery(Shrubbery sh1):
>     cdef Shrubbery sh2
>     sh2 = Shrubbery()
>     sh2.width = sh1.width
> sh2.height = sh1.height
> return sh2
> 
> 2) Another indentation error
> (http://www.mudskipper.ca/cython-doc/docs/extension_types.html):
> cdef class CheeseShop:
> 
> cdef object cheeses
> 
> def __cinit__(self):
>     self.cheeses = []
> 
> property cheese:
> 
>     def __get__(self):
>         return "We don't have: %s" % self.cheeses
> 
>     def __set__(self, value):
>         self.cheeses.append(value)
> 
>     def __del__(self):
>         del self.cheeses[:]
> 
> 3) Again (http://www.mudskipper.ca/cython-doc/docs/extension_types.html):
> cdef class Parrot:
> 
> cdef void describe(self):
>     print "This parrot is resting."
> 
> cdef class Norwegian(Parrot):
> 
> cdef void describe(self):
>     Parrot.describe(self)
>     print "Lovely plumage!"
> 
> 4) This should be a header?
> (http://www.mudskipper.ca/cython-doc/docs/sharing_declarations.html):
> What a Definition File contains A definition file can contain:
> 
> 5) A linebreak error in
> (http://www.mudskipper.ca/cython-doc/docs/sharing_declarations.html):
> "cdef float cube(float)" should go before "spammery.pyx"
> 
> 6) The Sharing extension types example is confusing because the file
> names are mixed into the code.  They should be split (and in different
> colors as in the "Using cimport to resolve naming conflicts" section).
> 
> 7) The highlighting on "The cdef extern from clause does three
> things:" is wrong
> (http://www.mudskipper.ca/cython-doc/docs/external_C_code.html)
> 
> 8) There's a table missing in the "Styles of struct, union and enum
> declaration" section
> (http://www.mudskipper.ca/cython-doc/docs/external_C_code.html)
> 
> 9) In "Declaring a function as callable without the GIL," I think
> there should be a with before the nogil in the final example.  The
> last sentence may have a typo as well.  I could be wrong though: I
> don't actually know the syntax you're explaining.
> 
> 10) Capitalization problem
> (http://www.mudskipper.ca/cython-doc/docs/pyrex_differences.html)
> Cdef bint b = x
> 
> David
> _______________________________________________
> Cython-dev mailing list
> Cython-dev at codespeak.net
> http://codespeak.net/mailman/listinfo/cython-dev