Тип хинтинга и генерация эпидока

В качестве примера приведена следующая функция:

def add(x: int, y: int) -> int:
    """
    @param x: the first integer
    @param y: the second integer
    """
    return x + y

Как я могу запустить epydoc (или pydoc), чтобы он распознавал подсказки типов и дал мне документацию, в которой указаны @type x, @type y и @rtype?

В настоящее время у меня возникает следующая ошибка (из-за использования подсказок типа).

| No documentation available!
|     Error: Import failed:
|            SyntaxError: invalid syntax (test.py, line 1)
|     Error: Source code parsing failed:
|            Error during parsing: invalid syntax (/home/..., line 
|            1) -- Bad function definition line
|   
  Error: Nothing left to document!

Спасибо вам. С уважением.

0 ответов

Другие вопросы по тегам