Основные правила написания docstring в Python регламентирует стандарт PEP-257. 1
Для однострочных строк документации: 3
- Закрывающие кавычки находятся на той же строке, что и открывающие. 3
- Не нужно добавлять пустую строку ни перед, ни после строки документации. 3
- Однострочная документация не должна быть простой «подписью», повторяющей параметры функции или метода. 4
Для многострочных строк документации: 3
- Многострочные строки состоят из резюмирующей однострочной строки документации, за которой следует пустая строка, а затем более подробное описание. 3
- Резолютивная строка может быть на той же строке, что и открывающие кавычки, или на следующей. 2
- Весь docstring имеет отступ такой же, как и кавычки на первой строке. 2
- После всех документаций (однострочных или многострочных), которые используются в классе, нужно оставлять пустую строку. 4
Также на первой строке должен быть именно строковый тип данных, а не комментарий. 1