How do put a bullet list in docstring for 'Raises'?

640 views Asked by At

I couldn't figure out how to create a bullet list for Raises. See below. Is it even possible? What I got is a single bullet point for RuntimeError (same for ValueError). Like:

   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
        """
0

There are 0 answers