Как отключить предупреждения «Отсутствует строка документации» на уровне файла в Pylint?

Pylint выдает ошибки, что в некоторых файлах отсутствуют строки документации. Я пытаюсь добавить строки документации к каждому классу, методу и функции, но кажется, что Pylint также проверяет, должны ли файлы иметь строку документации в начале. Могу я как-нибудь это отключить? Я хотел бы получить уведомление о том, что в классе, функции или методе отсутствует строка документации, но не обязательно, чтобы файл имел строку документации.

(Есть ли термин из юридического жаргона, который часто встречается в начале проприетарного исходного файла? Есть примеры? Я не знаю, можно ли размещать такой тривиальный вопрос отдельно.)

60
задан Mridang Agarwalla 10 November 2016 в 11:56
поделиться

1 ответ

С pylint 2.4 и выше Вас может дифференцироваться между различным missing-docstring при помощи трех после подсообщений:

  • C0114 (missing-module-docstring)
  • C0115 (missing-class-docstring)
  • C0116 (missing-function-docstring)

Так следующий .pylintrc файл должен работать:

[MASTER]
disable=
    C0114, # missing-module-docstring
2
ответ дан 24 November 2019 в 17:42
поделиться
Другие вопросы по тегам:

Похожие вопросы: