微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

如何在文档字符串中为“Raises”添加项目符号列表?

如何解决如何在文档字符串中为“Raises”添加项目符号列表?

我不知道如何为 Raises 创建项目符号列表。见下文。甚至有可能吗?我得到的是 RuntimeError一个要点(ValueError 相同)。 喜欢:

   Raises:      • RuntimeError -
                     ◦ case1: when x happens * case 2: when y happens
                • ValueError -
                     ◦ a is not all lowercase * current day is Sunday
class A
    def f1(self,a: str):
        """f1

        Parameters
        ----------
        a: str
            a

        Raises
        ------
        RuntimeError
            * case 1: when x happens
            * case 2: when y happens

        ValueError
            * ``a`` is not all lowercase
            * current day is Sunday
        """

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。