Принудительный аргумент и возврат документации в строке документации

Я пытаюсь добавить линтер в репо, который будет обеспечивать документирование аргументов и возвращаемых значений для функций и методов, как описано в Руководстве по стилю Google Python.

В общем, я хочу обеспечить соблюдение следующего содержания строки документации:

      def blah(n: int) -> int:
    """
    Args:
        n: a number
    
    Returns:
        The number plus 1
    """
    return n+1

Я заглянул в YAPF, собственный инструмент форматирования Python от Google, но не смог найти аргумент конфигурации и возвращаемые значения. Более широкий поиск по этой теме ничего не дал.

Как с помощью линтера обеспечить соблюдение документации по аргументам и возвращаемым значениям в строке документации?

0 ответов

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