Changes between Version 3 and Version 4 of Submitting/wxGUI

Timestamp:

Jun 13, 2014, 4:53:30 AM (10 years ago)

Author:

lucadelu

Comment:

--

Submitting/wxGUI

@@ -48 +48 @@
 == Documentation and comments ==
 
+== Documentation and comments ==
+Some information about docstrings:
+
+ * always use """triple double quotes""" around docstrings
+ * there's no blank line either before or after the docstring
+ * add information on the parameters used by the function you have to use the following format 
+   {{{
+   :param TYPE NAMEPARAM: explanation
+   }}}
+   where TYPE is the type (bool, str, int) of parameter and it is optional; NAMEPARAM is the name of parameter
+ * add information about the return of function using
+   {{{
+   :return: explanation
+   }}}
+ * add reference to classes and function using
+   {{{
+   :class:`CLASSNAME`
+   :func:`FUNCNAME`
+   }}}
+ * add TODO in docstring as follow
+   {{{
+   .. todo::
+       information todo
+   }}}
+   in similar way you can add warning and note.
+
 When using class Signal from `grass.pydispatch.signal`, write a short description to as a constructor parameter and describe implementation details in standard comments
 before the definition. Note the signal in each function which is invoking it.