On Mon, 2009-05-04 at 08:38 +0100, Adam Charrett wrote: > Thanks Jason, I don't believe that form was available when I wrote the > original code.
That's probably true. It was only recently added (back in February). > I did find it difficult to find a nice way of documenting > the signals and this certainly seems like a very nice inline way of > doing it. I ended up adding them to the class documentation, but without > any markup :-( Yeah, although to benefit from the signal docstrings you really need to be using reST, in combination with the doc generation stuff provided by kaa.base, which extends Sphinx in useful ways. It's probably not worth the effort retrofitting all of Freevo 1.x to use reST. In any case though you could use __kaasignals__ to provide inline documentation to other developers, even if it's not going to be used in generated code (and so markup isn't going to be useful). > Thanks for reminding me of the kaa documentation :-) And if you have any questions or find problems with it, please let me know. It still needs some love, but should at this point be useful. ------------------------------------------------------------------------------ Register Now & Save for Velocity, the Web Performance & Operations Conference from O'Reilly Media. Velocity features a full day of expert-led, hands-on workshops and two days of sessions from industry leaders in dedicated Performance & Operations tracks. Use code vel09scf and Save an extra 15% before 5/3. http://p.sf.net/sfu/velocityconf _______________________________________________ Freevo-devel mailing list Freevo-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/freevo-devel
