[sugar] apis at 4%

[David Farning]

On Sun, 2008-09-21 at 23:35 +0200, Marco Pesenti Gritti wrote:
> On Sun, Sep 21, 2008 at 7:00 PM, David Farning <dfarning at sugarlabs.org> wrote:
> >
> > The patches are flowing into the git tree correctly.  If you find bugs
> > or anything that looks kludge in the system, please let us know.  This
> > is the first time pydocweb has been used 'in the wild.'
> 
> It's great to see progress on this!
> 
> A couple of things:
> 
> * Is it ok to commit changes to the documentation in git? 
Yes

> Will pydocweb pick them up?
Yes, pydocweb uses merge from GNUs RCS to handle changes between the
docstrings in the pydocweb database and the source code.  Whatever merge
can not figure out, is flagged for editor attention.

>  There is a long line in alert.py which is causing a pylint warning.
Could you turn off the documentation related pylint warnings for now?  I
am getting hundreds of warnings from pydocweb about errors in our
docstrings:(  Over the next few weeks we can work through the pydocweb
warnings, then turn the pylint warning back on. 

> * I think it would be better to keep the top block of documentation
> under the license.

Which file was mangled? I can file a bug about the location of package
level docstrings.

thanks
david