Changes

Jump to: navigation, search

Programming guidelines

2 bytes removed, 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 [httphttps://gramps.svn.sourceforgegithub.netcom/viewvcgramps-project/gramps/trunktree/master/docs/ docs directory], for info read the [http://svn.code.sf.net/p/gramps/code/trunk/docs/README.txt README.txt] file.
:More info

Navigation menu