Python 2でreStructuredTextを使用して複数の戻り値を文書化するにはどうすればよいですか？

Question

Python docsは、「Pythonドキュメントに使用されているマークアップはreStructuredTextです」と言っています。私の質問は：ブロックのコメントは、複数の戻り値を表示するために書かれているはずですか？

def func_returning_one_value(): 
    """Return just one value. 

    :returns: some value 
    :rtype: str 
    """ 

def func_returning_three_values(): 
    """Return three values. 

    How do I note in reStructuredText that three values are returned? 
    """ 

私はreStructuredTextのを使用してPythonドキュメント上tutorialを見つけたが、それは複数の戻り値を文書化するための例を持っていません。 Sphinx docs on domainsはreturnsとrtypeについて述べていますが、複数の戻り値については言及していません。

Answer 1

コメントに記載されているとおり、使用する詳細な形式は厳密には定義されていません。

自分では、私は通常上記の表記法Field Listを使用します。それは改行をサポートしているので、あなたが必要と感じる場所を壊すだけです。

def my_func(param1, param2): 
    """ 
    This is a sample function docstring 

    :param param1: this is a first param 
    :param param2: this is a second param 
    :returns: tuple (result1, result2) 
     WHERE 
     str result1 is .... 
     str result2 is ....   
    """