[Yum-devel] API Docs

[Tim Lauridsen]

Florian Festi wrote:
> Hi!
> 
> While I like the fact that the yum wiki get used a bit more I still 
> think some things need to go into the source tree. What about starting a 
> file that documents the API changes so 3rd party vendors (and our own 
> developers) can see what we changed in the API for 4.0.x. It should 
> shortly mention what was changed/removed and how to work around the change.

Sounds like a good idea.
> 
> Any suggestions for a file name and location?
> 

README.API-CHANGES

> Of course there are some regular API docs missing, too...

Doctrings and epydoc (or something like it) could be a step in the right 
direction.

Tim