如何在Python 2中使用reStructuredText记录多个返回值？

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讨论了return和rtype,但没有讨论多个返回值.

解决方法:

正如评论中提到的第一次世界大战,没有严格定义要使用的详细格式.

对于我自己,我通常使用上面使用的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 ....        
    """

标签：python-2-7,restructuredtext,python,documentation
来源： https://codeday.me/bug/20191026/1938116.html