Changes

Jump to navigation Jump to search
m
no edit summary
Line 6: Line 6:  
= How To Guide =
 
= How To Guide =
   −
1.  Write a code example for using the code.  Try to write a stand alone python script that demonstrates the major features of the module and put in the ''examples'' directory in sugar-toolkit-gtk3.  If it can not be demonstrated standalone, write a code sample that the user could paste into their activity, simmilar to the ''sugar3.graphics.alert'' example.  When writing the example, add comments to explain what code is doing that might be non obvious (eg. that something is zero indexed, or that this function needs to be called first)
+
1.  Write a code example for using the code.  Try to write a stand alone python script that demonstrates the major features of the module and put in the ''examples'' directory in sugar-toolkit-gtk3.  If it can not be demonstrated standalone, write a code sample that the user could paste into their activity, like the ''sugar3.graphics.alert'' example.  When writing the example, add comments to explain what code is doing that might be non obvious (eg. that something is zero indexed, or that this function needs to be called first)
    
2.  Write a blurb (a small paragraph, around 3 lines) for the module and include your example.  Your blurb should say what this does and where to use it.  Place this between the license and the imports.  Including the example will always use the syntax ''.. literalinclude:: ../examples/SOMETHING.py''.  For example:
 
2.  Write a blurb (a small paragraph, around 3 lines) for the module and include your example.  Your blurb should say what this does and where to use it.  Place this between the license and the imports.  Including the example will always use the syntax ''.. literalinclude:: ../examples/SOMETHING.py''.  For example:

Navigation menu