digitalfabrik/integreat-cms

Docstrings
----------

Please add docstrings in the sphinx format (see :doc:`sphinx-rtd-tutorial:docstrings`)::

    """
    [Summary]

    :param [ParamName]: [ParamDescription], defaults to [DefaultParamVal]
    ...

    :return: [ReturnDescription]

    :raises [ErrorType]: [ErrorDescription]
    ...
    """


.. Hint::

    In the model documentation, the parameters are not required, because they are automatically derived from the
    model field type.

Whenever you want to document module/class attributes which are not parameters (i.e. because they are not passed to the
``__init__()``-function or contain static values), use inline comments::

    #: Description of attribute
    attribute = "value of this attribute"

See the configuration files :mod:`~integreat_cms.core.settings` and :mod:`conf` or :mod:`~integreat_cms.cms.constants` for examples.