在函数的文档字符串的“引发”部分中,是否也应该间接列出引发的异常?

问题描述

例如,对于:

def foo(a):
    if a == 10:
        raise FooError
    return 1 / a

foo的文档字符串中应包含以下内容:

"""Raises:
    FooError: if a is equal to 10.
    ZeroDivisionError: if a is equal to 0.
"""

还是应该只列出函数本身引发的异常,即。 e。 FooError?谢谢任何关于更好的见解。

解决方法

暂无找到可以解决该程序问题的有效方法,小编努力寻找整理中!

如果你已经找到好的解决方法,欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@)