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部分生成不同的东西？似乎pdoc 会做一些事情来区分文档字符串中的参数和返回语句。这可能是参数和返回语句的亮点、斜体字体或粗体字体，如下所示。无论发生什么，我都希望看到文本: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}