Как я отключаю “пропавших без вести docstring” предупреждения на уровне файла в Pylint?
Pylint бросает ошибки, что некоторые файлы пропускают docstrings. Я пытаюсь добавить docstrings к каждому классу, методу и функции, но кажется, что Pylint также проверяет, что файлы должны docstring в начале его. Я могу отключить это так или иначе? Я хотел бы быть уведомленным относительно docstring, отсутствует в классе, функции или методе, но это не должно быть обязательно, чтобы файл имел docstring.
(Есть ли термин легального жаргона, часто находимого в начале собственного исходного файла? Какие-либо примеры? Я не знаю, является ли это хорошо для регистрации такого тривиального вопроса отдельно.)
2 ответа
Edit "C:\Users\Your User\AppData\Roaming\Code\User\settings.json" and add
python.linting.pylintArgs lines at the end as shown below:
{
"team.showWelcomeMessage": false,
"python.dataScience.sendSelectionToInteractiveWindow": true,
"git.enableSmartCommit": true,
"powershell.codeFormatting.useCorrectCasing": true,
"files.autoSave": "onWindowChange",
"python.linting.pylintArgs": [
"--load-plugins=pylint_django",
"--errors-only"
],
}
С pylint 2.4 и выше Вас может дифференцироваться между различным missing-docstring при помощи трех после подсообщений:
-
C0114(missing-module-docstring) -
C0115(missing-class-docstring) -
C0116(missing-function-docstring)
Так следующий .pylintrc файл должен работать:
[MASTER]
disable=
C0114, # missing-module-docstring