Параметры метода неправильно отформатированы в HTML, созданном pdoc - PullRequest
0 голосов
/ 17 октября 2019

У меня есть метод в классе, определенном как показано ниже:

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-код на рисунке ниже для этого метода:

enter image description here

Что мне нужно сделать, чтобы pdoc генерировал что-то другое для частей param и return строки документации? Похоже, что что-то будет сделано pdoc для дифференциации параметров и возврата операторов друг от друга в строке документации. Это может быть выделение параметров и операторов возврата, курсивный шрифт или жирный шрифт, как показано ниже. Что бы ни случилось, я бы хотел, чтобы текст :param и :return был удален из строки документации:

enter image description here

1 Ответ

1 голос
/ 17 октября 2019

Если вам нужна дополнительная ясность, вы можете попробовать что-то вроде ниже

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}

when called

...