在使用重构文本/ Sphinx进行文档记录时,如何在声明中包含参数类型?

时间:2016-11-06 14:55:58

标签: python python-sphinx restructuredtext

我熟悉使用2行代码记录Python函数的参数:

def get_market_history(self, market, count):
    """
    Used to retrieve the latest trades that have occured for a
    specific market.

    /market/getmarkethistory

    :param market: String literal for the market (ex: BTC-LTC)
    :type market: str

但我理解,对于简单类型,您可以在:param行中包含类型,因此只需要一行而不是两行。但我忘了这个的语法,并希望得到一个例子。

1 个答案:

答案 0 :(得分:1)

来自documentation

:param str sender: The person sending the message