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