diff --git a/python.ru.md b/python.ru.md index 0a97615..523985c 100644 --- a/python.ru.md +++ b/python.ru.md @@ -7,10 +7,31 @@ * Используем двойные кавычки для строк (`"string"`), не используем одинарные (`'string'`). * Добавляем аннотации типов. * В случае длинных перечислений элементов коллекций или аргументов, после последнего аргумента добавляется запятая (для однородного автоформатирования). + * Докстринги всегда оформляем многострочно — см. раздел [Докстринги](#докстринги). Ниже приведены инструкции по настройке автоформатирования и code coverage из консоли. Для настройки интеграции с VSCode воспользуйтесь [инструкцией](https://docs.google.com/document/d/19gT4BH6MO-XXyqqzTOoz-jhY0ITbeGKDOZ8FbV_J1tc). +## Докстринги + +Докстринг всегда многострочный, независимо от длины текста: + * после открывающих `"""` на той же строке ничего не пишем — текст начинается со следующей строки; + * закрывающие `"""` стоят на отдельной строке. + +```python +# Плохо +def crc16(data: bytes) -> int: + """Return the CRC-16/Modbus of *data* as a 16-bit int.""" + +# Хорошо +def crc16(data: bytes) -> int: + """ + Return the CRC-16/Modbus of *data* as a 16-bit int. + """ +``` + +Текущий набор инструментов (black/isort/pylint) это правило не проверяет — соблюдается на ревью. + ## Автоматическая проверка кода Для автоформатирования кода используется [black](https://github.com/psf/black) и [isort](https://github.com/PyCQA/isort).