У меня в пакете есть пара частично примененных функций (functools.partial). Как я могу их задокументировать? Я попытался установить myfunc.__doc__, но, похоже, это не сработало. Я хотел бы, чтобы документация отображалась при создании документов API с помощью Sphinx.
Примером может быть:
from collections import deque
from functools import partial
# Consume an iterable
consume = partial(deque, maxlen=0)
consume.__doc__ = "Consume an iterable"
Вместо добавления комментария в исходный файл, как указано выше, я хотел бы, чтобы он отображался как документированная функция, когда я создаю свои документы API с помощью sphinx или когда я импортирую его в интерактивном режиме и вызываю help(consume). Что-то вроде:
consume(Iterable)
Consume an iterable
Вот и обновил __doc__. Но при вызове help(consume) по-прежнему отображаются документы для partial, а Sphinx полностью игнорирует consume (см. Снимок экрана)! Этот пример тривиален, но в моем пакете есть и другие случаи, когда в документации много чего можно упомянуть, например, примеры кода.
Изменить : я думаю, у меня есть запасной вариант, чтобы написать однострочную оболочку функции.