PyCodeStyle - Sublime Text 3 - Длина строки комментария

Я успешно настроил Sublime Text 3 для работы с SublimeLinter и PyCodeStyle. Мне нравится использовать его, чтобы сохранять честность, и я настроил свой конфигурационный файл SublimeLinter для PyCodeStyle, чтобы игнорировать определенные предупреждения. Вот мой файл, как он существует сейчас.

{
"linters": {
"pycodestyle": {
  "ignore": ["E111", "E114"],
  "max-doc-length": 60,
},
// ... other linters' settings
}

Я игнорирую E111 и E114, так как для моего проекта я должен использовать отступ шириной 2, и я не хочу, чтобы на меня кричали, потому что я не использовал кратное 4.

Часть, с которой у меня проблемы, - это вторая команда, где моя цель - получать предупреждения, когда мои строки комментариев слишком длинные. У меня он установлен на 60 (несмотря на предложение PEP 72, которое я намерен использовать), просто чтобы заставить его отключить линтер.

Независимо от того, что я установил, я никогда не получу предупреждение, которое ожидаю получить (W505: слишком длинная строка документа). (Я никогда не получаю никаких предупреждений.) Я также пробовал "-max-doc-length" и "--max-doc-length", так как я знаю, что последний вариант, когда это делается через командную строку.

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

Может ли это быть проблема версии? Я заметил, что могу видеть опцию, которую я цитирую выше, на веб-странице PyCodeStyle (поиск "--max-doc-length=n"); однако в моей системе, когда я печатаю pycodestyle --help Я не вижу такой возможности. Я вижу --max-line-length=n вариант, но не док-линия под ним.

Выход из pycodestyle --version является 2.4.0,

1 ответ

Решение

Во-первых, да, есть проблема с версией. Даже если у вас установлена ​​последняя версия (2.4.0, выпущенная 10 апреля 2018 года), max-doc-length был добавлен после того, как эта версия была выпущена, 11 мая 2018 года.

Я не уверен, почему он был добавлен в документы для 2.4.0, когда он там недоступен (возможно, потому что они еще не повысили версию в репозитории до 2.4.1?), Но я не уверен об этой ошибке стоит сообщить.

В любом случае, если вам нужна эта функция (и вы не хотите ждать следующей версии), вам придется установить новейшую версию с GitHub.


Тем не менее, я не думаю, что вы все равно хотите эту функцию.

max-doc-length (и соответствующее предупреждение W505) для строк документации, а не для комментариев. Таким образом, он по-прежнему не будет ничего делать, чтобы обнаружить слишком длинные строки комментариев.

Насколько я знаю, pycodestyle не имеет никакого способа указать другую длину для комментариев; они всегда получают max-line-length,

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