[Bf-committers] Python API Documentation

[Stephen Swaney]

On Mon, Aug 16, 2010 at 05:46:26PM +0200, neXyon wrote:
> 2) Have a database with a nice structure to store docs
> 
> Advantages:
> * Easy to edit for everybody, there could be a web interface to edit 
> docs directly
> * Lower binary size
> Disadvantages:
> * No docstrings, so no direct documentation in the interpreter, although 
> the help function could be overwritten to retrieve the docs from the DB

Not having docstrings is a *major* drawback.  Not only are they expected
to be there, they are one of the features that makes developing python
code an enjoyable experience.

-- 
Stephen Swaney			
sswaney at centurytel.net