Open
Description
Current behavior:
Currently, in tuf/api/metadata.py
we are using multiple ways to document our custom TUF exceptions.
There are two main ways of how we handle exceptions:
- there are places where we define an exception with the full module name:
python-tuf/tuf/api/metadata.py
Line 185 in 0f1fc6e
- and in other cases, we document only the name of the exception:
python-tuf/tuf/api/metadata.py
Line 346 in 0f1fc6e
Expected behavior:
Decide how we want to document our exceptions and stick to that.
Document how we should write docstrings about exceptions somewhere.
I didn't find any mentions about the exception docstrings in the Google Python guidelines