Более 1 строки документации для одного модуля / функции и т. Д.?
Я использую Python 3.1.
Можно ли создать более 1 строки документации для одного модуля или функции? Я создаю программу и собираюсь создать несколько строк документации с категориями для каждой. Я намерен дать другим людям программу, чтобы они могли ее использовать, и чтобы упростить задачу как для программистов, так и для непрограммистов, я помещаю ссылку на строку документации для документации в самой программе.
Чтобы быть более конкретным, у меня есть меню в программе / модуле в качестве интерфейса, и одна из опций позволит получить доступ к строке документации модуля для документации по программе. Таким образом, если это возможно, я хочу создать несколько строк документации для классификации различных типов документации. Так что пользователям было бы легче, если бы они захотели увидеть какую-то часть документации.
например. Первая строка документации содержит инструкции по использованию программы. Вторая строка документации содержит информацию о том, как работает одна часть программы. Третья строка документации содержит информацию о том, как работает другая часть. и т.п.
Это возможно? И если да, то как вы на них ссылаетесь?
Обновления: добавлен комментарий.
Моя первоначальная мысль заключалась в том, чтобы иметь более одной строки документации в смысле:
def foo():
"""docstring1: blah blah blah"""
"""docstring2: blah blah blah"""
pass # Insert code here
Тогда был бы некоторый код, который я мог бы использовать, чтобы позволить мне ссылаться на каждую из этих строк документации. Итак, я предполагаю, что это не возможно тогда?