On Tue, Jan 22, 2008 at 08:44:40PM -0500, Steve Milner wrote: > I was showing func off to a coworker the other day when a question came up ... > > "This is pretty cool ... where can I get the Code/API documentation?" > The obvious answer is to look at the code ... but why not use > something like epydoc? In past projects it has been helpful and > generally improved the documentation in the code. I agree. Epydoc rocks. We used it with another, no defunct, project. > You can see what it looks like rendered for a module at > http://stevemilner.org/tmp/html/. > > I'm also attaching a diff to show what it looks like in code (though > I'm being more verbose with self than need be ... as well as types > ...) > > On the good side we *should* have documentation of modules and epydoc > would document it in the code as well as generated html api > documentation. > > On the bad side it does add more lines to the docstrings which could > be seen as adding too much to the noise to code ratio. > > Also epydoc can be used without the extra @tags it's just less verbose > documentation. Yeah, those @tags make it so, um, java :) > Any objections, better ideas or questions about my sanity? I like it. I'd be happy to go through the code a bit more and put some in. It is a tedious task but useful. -- jesus m. rodriguez | jesusr@xxxxxxxxxx sr. software engineer | irc: zeus red hat network | 919.754.4413 x44413 +-------------------------------------------+ | "Those who cannot learn from history | | are doomed to repeat it." | | -- George Santayana | +-------------------------------------------+ _______________________________________________ Func-list mailing list Func-list@xxxxxxxxxx https://www.redhat.com/mailman/listinfo/func-list
