Я создаю функции docstring, которые принимают функции обратного вызова в качестве аргументов. Разработчики клиентского кода должны знать, какой rtype ожидается от каждой переданной функции.
Каково принятое соглашение для указания этого в строке документации :param объекта функции?
Примечание. Этот вопрос отличается от Как документировать :rtype: для функции, которая возвращает несколько возможных типов данных?.
Редактировать: Сейчас я использую это:
:param predicate: Determines when to consolidate two adjacent
MyClass instances.
:type predicate: callbackFunction(thing1, thing2) -> bool
