2015-05-14 3 views
2

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

""" 
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 
""" 
+1

Вы прочитали https://www.python.org/dev/peps/pep-0257/? –

+0

Я предпочел бы второй, будет держать докшлингу более читабельным. Если одна и та же ошибка возникает по более чем двум причинам, она будет держать линии короче. –

+0

@VivekSable Это ничего не говорит о том, что пытается делать OP, не так ли? –

ответ

0

Я думаю, что идти с второй.

""" 
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. ... 
""" 
+0

@dbliss: ok. может быть. Я прочитал ваш комментарий после отправки ответа. Вы можете добавить свой ответ, я буду голосовать. –

Смежные вопросы