| | 50 | == Documentation and comments == |
| | 51 | Some information about docstrings: |
| | 52 | |
| | 53 | * always use """triple double quotes""" around docstrings |
| | 54 | * there's no blank line either before or after the docstring |
| | 55 | * add information on the parameters used by the function you have to use the following format |
| | 56 | {{{ |
| | 57 | :param TYPE NAMEPARAM: explanation |
| | 58 | }}} |
| | 59 | where TYPE is the type (bool, str, int) of parameter and it is optional; NAMEPARAM is the name of parameter |
| | 60 | * add information about the return of function using |
| | 61 | {{{ |
| | 62 | :return: explanation |
| | 63 | }}} |
| | 64 | * add reference to classes and function using |
| | 65 | {{{ |
| | 66 | :class:`CLASSNAME` |
| | 67 | :func:`FUNCNAME` |
| | 68 | }}} |
| | 69 | * add TODO in docstring as follow |
| | 70 | {{{ |
| | 71 | .. todo:: |
| | 72 | information todo |
| | 73 | }}} |
| | 74 | in similar way you can add warning and note. |
| | 75 | |
