Changes

Jump to: navigation, search

Programming guidelines

16 bytes added, 04:49, 2 April 2016
Docstrings
* Python provides a docstrings to document classes and functions. If the class is a class used by others (such as the [http://www.gramps-project.org/docs/gen/gen_lib.html#module-gen.lib gen lib] classes), the docstrings should follow the restructuredtext ([http://docutils.sourceforge.net/docs/user/rst/quickstart.html#structure rst]) format. This allows us to extract [http://www.gramps-project.org/docs/ 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 [https://github.com/gramps-project/gramps/tree/master/docs docs directory], for info read the [httphttps://svngithub.code.sf.netcom/pgramps-project/gramps/codeblob/trunkmaster/docs/README.txt /docs/README.txt] file.
:More info

Navigation menu