Jump to: navigation, search

Programming guidelines

23 bytes removed, 04:01, 28 December 2012
Docstrings: update link
* Python provides a docstrings to document classes and functions. If the class is a class used by others (such as the [ gen lib] classes), the docstrings should follow the restructuredtext ([ rst]) format. This allows us to extract [ API] documentation using sphinx.
* Apart from adding doc strings to classes and functions, also the api generating rst files must be edited so as to extract the documentation. These files are in the [ docs directory], for info read the [ README.txt] file.
:More info

Navigation menu