#8503 LOW Opportu: add docstrings to alert.py
Zarro Boogs per Child
bugtracker at laptop.org
Tue Sep 16 10:02:21 EDT 2008
#8503: add docstrings to alert.py
-----------------------------+----------------------------------------------
Reporter: dfarning | Owner: marco
Type: enhancement | Status: new
Priority: low | Milestone: Opportunity
Component: sugar-toolkit | Version: not specified
Resolution: | Keywords:
Next_action: never set | Verified: 0
Blockedby: | Blocking:
-----------------------------+----------------------------------------------
Comment(by dfarning):
An example of the output is at
http://sugarlabs1.xen.prgmr.com/pydocweb/doc/sugar.graphics.alert.Alert.add_button/
The format is something called restructured text. It is the most common
markup currently used by professional python api writers.
As for the self parameter, I can pull those out. In the link above, there
is a combo button titled review status. The doc string has several more
levels of review to go through before being finally approved.
Hopefully, I and others will start hacking on the wiki. Whenever a good
sized chuck of documentation has been written, I will submitted a patch.
I'll remove the self parameters and resubmit.
--
Ticket URL: <http://dev.laptop.org/ticket/8503#comment:3>
One Laptop Per Child <http://laptop.org/>
OLPC bug tracking system
More information about the Bugs
mailing list