[sugar] Now YOU can write API documentation
Wed Sep 24 07:55:32 EDT 2008
On Sat, Sep 20, 2008 at 04:58, David Farning <dfarning at sugarlabs.org> wrote:
> Now you can learn to document sugar APIs from the comfort of your own
> With the help of Pauli Virtanen, Janet Swisher, and Marco, we now have a
> wiki based tool for documenting sugar apis! Take a look at
> http://sugarlabs1.xen.prgmr.com .
> Follow the instructions at
> http://sugarlabs1.xen.prgmr.com/pydocweb/wiki/getting_started/ to get
> Don't worry about being perfect, someone will come along and clean up
> the docstrings before they are committed back to the git tree.
> To get us started, I have been adding function summaries and parameter
> lists to the graphics package.
I've started on sugar.network as I went through that code recently.
Here's an issue with pydocweb:
doesn't show the name of a method starting with _ - _handle_accept. I
knew it existed, so I manually edited the URL to
get to http://sugarlabs1.xen.prgmr.com/pydocweb/doc/sugar.network.GlibTCPServer._handle_accept/
which I edited.
More information about the Sugar-devel