Documenting extension modules?

2005-07-15 Thread Francois De Serres
Hiho, I can't seem to find a proper way to document my extension module. Following the C API doc: static PyMethodDef ioMethods[] = { {o_count, o_count, METH_VARARGS, Return the count of available MIDI outputs.}, } lacks: a) module level documentation b) function parameters Also,

Re: Documenting extension modules?

2005-07-15 Thread Robert Kern
Francois De Serres wrote: Hiho, I can't seem to find a proper way to document my extension module. Following the C API doc: static PyMethodDef ioMethods[] = { {o_count, o_count, METH_VARARGS, Return the count of available MIDI outputs.}, } lacks: a) module level

Re: Documenting extension modules?

2005-07-15 Thread Francois De Serres
Robert Kern wrote: Francois De Serres wrote: Hiho, I can't seem to find a proper way to document my extension module. Following the C API doc: static PyMethodDef ioMethods[] = { {o_count, o_count, METH_VARARGS, Return the count of available MIDI outputs.}, } lacks: a) module

Re: Documenting extension modules?

2005-07-15 Thread Simon Dahlbacka
Re: assigning a PyStr object to __doc__, take a look at Py_InitModule3, which does that for you. Then you have the PyDoc_STRVAR macro in python.h that you might want to use (see definition below). But as Robert already told you, you'll need to provide the necessary information about i.e.

Re: Documenting extension modules?

2005-07-15 Thread Francois De Serres
Simon Dahlbacka wrote: Re: assigning a PyStr object to __doc__, take a look at Py_InitModule3, which does that for you. got it, thx. Then you have the PyDoc_STRVAR macro in python.h that you might want to use (see definition below). But as Robert already told you, you'll need to provide the