Jesus M. Rodriguez wrote:
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.
The one thing I don't want to see is a bunch of javadoc-miming, where we
have stuff like
@param thisIsAFoo -- this parameter is a Foo
which is not kept updated and isn't useful.
I would actually like to see more /user/ level documentation built first
... code generated docs only go so far.
_______________________________________________
Func-list mailing list
Func-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/func-list
