python - pdoc 生成的 HTML 中的方法参数格式不正确

Question

我在类中定义了一个方法，如下所示:

def my_method(self, a: str = None, b: str = None) -> typing.Set[str]:
    """
    Do something

    :param a: A string to represent something.

    :param b: A string to represent something else.

    :return: A set of strings.
    """

    return {a, b}

pdoc 为该方法生成下图中的 HTML:

我需要做什么才能使 pdoc 为文档字符串的 param 和 return 部分生成不同的内容？似乎 something 将由 pdoc 完成以区分 docstring 中的参数和返回语句。这可能是参数和返回语句、斜体或粗体的突出显示，如下所示。无论发生什么，我都希望看到文本 :param 和 :return 从文档字符串中删除:

Answer 1

如果你想进一步弄清楚，那么你可以尝试下面的方法

def my_method(self, a: str = None, b: str = None) -> typing.Set[str]:
    """
    Do something

    Args:
        a (str): The first parameter.
        b (str): The second parameter.

    Returns:
        Set: The return value. If result has values then Set of string, otherwise empty set.

    """
    s._parse_hh_mm_ss_ff()
    return {a, b}