numpy/scipy ドキュメントへのガイドの規則に従って、関数パラメーターは次の方法でドキュメント化する必要があります。
def foo(x):
"""" This function does nothing
Parameters
----------
x : type
Description of parameter `x`.
""""
pass
type がintやstrなどの個別の型である場合、これは簡単です。
ここで、パラメーターをBaseClassのインスタンスにするか、同じインターフェイスを公開する任意のオブジェクト ( BaseClassから派生したクラスなど) にする必要があります。パラメータxが特定のインターフェイスを (派生またはダックタイピングによって) 公開する必要があることを簡潔に文書化する方法はありますか?