Обычная практика для документирования типов возврата параметров функции обратного вызова? - PullRequest
0 голосов
/ 07 июня 2018

Я - функции документирования, которые принимают функции обратного вызова в качестве аргументов.Разработчики клиентского кода должны знать, какой rtype ожидается от каждой переданной функции.

Что является принятым соглашением для указания этого в: param docstring объекта функции?

Примечание. Этот вопрос отличаетсяс Как мне документировать: rtype: для функции, которая возвращает несколько возможных типов данных? .

Редактировать: Пока я использую это:

:param predicate: Determines when to consolidate two adjacent 
                  MyClass instances.
:type predicate: callbackFunction(thing1, thing2) -> bool
...