У меня есть модуль, errors.py
, в котором определены несколько глобальных констант (примечание: я понимаю, что у Python нет констант, но я определил их по соглашению с помощью UPPERCASE).
"""Indicates some unknown error."""
API_ERROR = 1
"""Indicates that the request was bad in some way."""
BAD_REQUEST = 2
"""Indicates that the request is missing required parameters."""
MISSING_PARAMS = 3
Использование reStructuredText, как я могу документировать эти константы? Как вы можете видеть, я перечислил docstring над ними, но я не нашел никакой документации, которая указывает на это, я только что сделал это как предположение.