简单的sphinx doc,参数和返回值

时间:2014-05-18 01:56:45

标签: python python-sphinx

我想知道使用Sphinx doc在文档字符串中记录参数含义和函数/方法返回值的标准系统是什么。例如:

def func(arg1, arg2):
    """do something
       - indicate that arg1 is an argument and what its meaning is
       - indicate that arg2 is an argument and what its meaning is
       - indicate what the return value is and what its meaning is
    """
    pass

我发现Python的所有例子都没有明确地记录他们的论点,或者有更复杂的东西。

0 个答案:

没有答案