DLR-RM/RAFCON

Extend docstrings of functions/methods by the :raises: field

franzlst opened this issue · 1 comments

Each method/function raising an exception should document this in its docstring using the :raises field.

E.g.:

"""My method

Does something...

:param int value: foobar
:raises exceptions.ValueError: if something is wrong
"""

Originally created by @franzlst (Franz.Steinmetz@dlr.de) at 2015-11-26 09:00:06+00:00 (moved from RMC internal repository)

solved with commit e42b1cbf23d1e

Originally created by @sebastian-brunner (Sebastian.Brunner@dlr.de) at 2016-08-09 08:06:15+00:00 (moved from RMC internal repository)