[Yum-devel] documentation!

Menno Smits menno-yum at freshfoo.com
Sun Oct 29 23:33:32 UTC 2006


Luke Macken wrote:
> I noticed a while back that Menno mentioned[0] he was going to produce
> plugin documentation using epydoc.  I'm not sure what ever came of this,
> but I'm interested in generating epydoc for all of yum.

It never happened because Seth said it probably wasn't worthwhile 
generating the docs until the API stablised. I guess the API is getting 
more stable now so now might be a good time to start.

> Even in the projects current state without epytext[1] docstrings, it still
> is extremely useful for reference/navigation/learning the internals of
> yum.  I, for one, am also willing to help go through the code and add useful
> epytext docstrings as well 
> 
> What does everyone else think?

I think it's a great idea.

Menno

Scanned by the NetBox from NetBox Blue
(http://netboxblue.com/)




More information about the Yum-devel mailing list