Как использовать строки документации в модулях Python?

Строки документации (docstrings) в Python пишутся сразу после определения функции, метода, класса или модуля. pythonist.ru Они используются для документирования кода. pythonist.ru

Для модулей строки документации помещаются в начало файла, перед любым импортом. popov.dev Они должны включать: popov.dev

• краткое описание модуля и его назначение; popov.dev
• список любых классов, исключений, функций и любых других объектов, экспортируемых модулем. popov.dev

Для функций модуля строки документации должны содержать: popov.dev

• краткое описание того, что это за функция и для чего она используется; popov.dev
• любые передаваемые аргументы (как обязательные, так и необязательные), включая аргументы ключевых слов; popov.dev
• любые побочные эффекты, возникающие при выполнении функции; popov.dev
• любые возникающие исключения; popov.dev
• есть ли какие-либо ограничения на то, когда функция может быть вызвана. popov.dev

Строки документации могут иметь различное форматирование. pythonchik.ru Для более удобной работы с документацией в Python существует встроенная библиотека pydoc, которая автоматически генерирует документацию из модулей. pythonchik.ru

Соглашения о строках документации описаны в PEP 257. popov.dev