Python 2에서 reStructuredText를 사용하여 여러 개의 반환 값을 문서화하는 방법은 무엇입니까?

Question

Python docs은 "파이썬 문서에 사용 된 마크 업은 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를 사용하여 파이썬 문서에 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 ....   
    """