简体   繁体   中英

How to include the type of a parameter with its declaration when documenting with restructured text/Sphinx?

I am familiar with documenting the parameters of a Python function using 2 lines like so:

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

but I understand that for simple types you can include the type in the :param line, thus only needing one line instead of two. But I forgot the syntax for that and would appreciate an example.

:param str sender: The person sending the message文档 :param str sender: The person sending the message

The technical post webpages of this site follow the CC BY-SA 4.0 protocol. If you need to reprint, please indicate the site URL or the original address.Any question please contact:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM