Как мне сгруппировать похожие исключения в строке документации?

Я не вижу упоминания об этом ни в одном руководстве по стилю. Должен ли я объединить похожие типы исключений или разделить их на отдельные строки:

"""
This is a Google style docs.
...
...
Raises:
    TypeError: foo() missing 1 required positional argument. Key must be a numeric value.
    KeyError: bar
"""

или это:

"""
This is a Google style docs.
...
...
Raises:
    TypeError: foo() missing 1 required positional argument
    TypeError: key must be a numeric value
    KeyError: bar
"""

python docstring
person Eyeofpie    schedule 14.05.2015    source источник
comment
Вы читали python.org/dev/peps/pep-0257?   -  person Vivek Sable    schedule 14.05.2015
comment
Я бы предпочел второй, он сделает строку документации более читабельной. Если одна и та же ошибка возникает по более чем двум причинам, строки также будут короче.   -  person Anshul Goyal    schedule 14.05.2015
comment
@VivekSable Это ничего не говорит о том, что пытается сделать OP, не так ли?   -  person Anshul Goyal    schedule 14.05.2015
comment
как насчет второго варианта, но с TypeError:, удаленным из второй строки, поэтому вторая строка начинается с key, с отступом прямо под foo.   -  person dbliss    schedule 14.05.2015
comment
@Eyeofpie Я не знаю, есть ли для этого официальная конвенция Python. на вашем месте я бы посмотрел, как это делает основной пакет (например, numpy), и скопировал их.   -  person dbliss    schedule 14.05.2015

Ответы (1)


arrow_upward
0
arrow_downward

Я думаю пойти со вторым.

"""
This is a Google style docs.
...
...
Raises:
    TypeError: 1. foo() missing 1 required positional argument.
               2. key must be a numeric value.
               3. ...
    KeyError:  1. bar key is missing.
               2. ...
"""
person Vivek Sable    schedule 14.05.2015
comment
@dbliss: хорошо. может быть. Я прочитал ваш комментарий после публикации ответа. Вы можете добавить свой ответ, я буду голосовать. - person Vivek Sable; 14.05.2015