Разница между однострочными и многострочными docstrings заключается в их структуре и использовании:
- Однострочные docstrings помещаются в одну строку. 13 Они должны использоваться с короткими и простыми функциями. 3 Закрывающие кавычки находятся в той же строке, что и открывающие. 1
- Многострочные docstrings состоят из резюмирующей однострочной строки документации, за которой следует пустая строка, а затем более подробное описание. 5 Они используются для более длинных и сложных функций, модулей или классов. 3
Таким образом, однострочные docstrings прописывают функцию или действие метода как команду, а не как описание функции, а многострочные содержат также описание параметров функции и возвращаемых значений, которое отделено от строки-команды пустой строкой. 4