Правила Ruff, связанные с pydocstyle (D)
Правила Ruff, связанные с pydocstyle. Подробнее об этом плагине на его странице PyPI
Часть категории Правила проверок кода в Ruff.
Ruff undocumented-public-package (D104)
undocumented-public-package в Ruff проверяет код на предупреждение D104. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила undocumented-public-package и …
Ruff undocumented-magic-method (D105)
undocumented-magic-method в Ruff проверяет код на предупреждение D105. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила undocumented-magic-method и …
Ruff undocumented-public-nested-class (D106)
undocumented-public-nested-class в Ruff проверяет код на предупреждение D106. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила undocumented-public-nested-class и …
Ruff undocumented-public-init (D107)
undocumented-public-init в Ruff проверяет код на предупреждение D107. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила undocumented-public-init и …
Ruff unnecessary-multiline-docstring (D200)
unnecessary-multiline-docstring в Ruff проверяет код на предупреждение D200. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила unnecessary-multiline-docstring и …
Ruff blank-line-before-function (D201)
blank-line-before-function в Ruff проверяет код на предупреждение D201. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила blank-line-before-function и …
Ruff blank-line-after-function (D202)
blank-line-after-function в Ruff проверяет код на предупреждение D202. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила blank-line-after-function и …
Ruff incorrect-blank-line-before-class (D203)
incorrect-blank-line-before-class в Ruff проверяет код на предупреждение D203. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила incorrect-blank-line-before-class и …
Ruff incorrect-blank-line-after-class (D204)
incorrect-blank-line-after-class в Ruff проверяет код на предупреждение D204. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила incorrect-blank-line-after-class и …
Ruff missing-blank-line-after-summary (D205)
missing-blank-line-after-summary в Ruff проверяет код на предупреждение D205. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила missing-blank-line-after-summary и …
Ruff docstring-tab-indentation (D206)
docstring-tab-indentation в Ruff проверяет код на предупреждение D206. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила docstring-tab-indentation и …
Ruff under-indentation (D207)
under-indentation в Ruff проверяет код на предупреждение D207. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила under-indentation и …
Ruff over-indentation (D208)
over-indentation в Ruff проверяет код на предупреждение D208. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила over-indentation и …
Ruff new-line-after-last-paragraph (D209)
new-line-after-last-paragraph в Ruff проверяет код на предупреждение D209. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила new-line-after-last-paragraph и …
Ruff surrounding-whitespace (D210)
surrounding-whitespace в Ruff проверяет код на предупреждение D210. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила surrounding-whitespace и …
Ruff blank-line-before-class (D211)
blank-line-before-class в Ruff проверяет код на предупреждение D211. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила blank-line-before-class и …
Ruff multi-line-summary-first-line (D212)
multi-line-summary-first-line в Ruff проверяет код на предупреждение D212. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила multi-line-summary-first-line и …
Ruff multi-line-summary-second-line (D213)
multi-line-summary-second-line в Ruff проверяет код на предупреждение D213. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила multi-line-summary-second-line и …
Ruff overindented-section (D214)
overindented-section в Ruff проверяет код на предупреждение D214. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила overindented-section и …
Ruff overindented-section-underline (D215)
overindented-section-underline в Ruff проверяет код на предупреждение D215. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила overindented-section-underline и …
Ruff triple-single-quotes (D300)
triple-single-quotes в Ruff проверяет код на предупреждение D300. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила triple-single-quotes и …
Ruff escape-sequence-in-docstring (D301)
escape-sequence-in-docstring в Ruff проверяет код на предупреждение D301. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила escape-sequence-in-docstring и …
Ruff missing-trailing-period (D400)
missing-trailing-period в Ruff проверяет код на предупреждение D400. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила missing-trailing-period и …
Ruff non-imperative-mood (D401)
non-imperative-mood в Ruff проверяет код на предупреждение D401. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила non-imperative-mood и …
Ruff signature-in-docstring (D402)
signature-in-docstring в Ruff проверяет код на предупреждение D402. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила signature-in-docstring и …
Ruff first-word-uncapitalized (D403)
first-word-uncapitalized в Ruff проверяет код на предупреждение D403. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила first-word-uncapitalized и …
Ruff docstring-starts-with-this (D404)
docstring-starts-with-this в Ruff проверяет код на предупреждение D404. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила docstring-starts-with-this и …
Ruff non-capitalized-section-name (D405)
non-capitalized-section-name в Ruff проверяет код на предупреждение D405. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила non-capitalized-section-name и …
Ruff missing-new-line-after-section-name (D406)
missing-new-line-after-section-name в Ruff проверяет код на предупреждение D406. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила missing-new-line-after-section-name и …
Ruff missing-dashed-underline-after-section (D407)
missing-dashed-underline-after-section в Ruff проверяет код на предупреждение D407. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила missing-dashed-underline-after-section и …
Ruff missing-section-underline-after-name (D408)
missing-section-underline-after-name в Ruff проверяет код на предупреждение D408. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила missing-section-underline-after-name и …
Ruff mismatched-section-underline-length (D409)
mismatched-section-underline-length в Ruff проверяет код на предупреждение D409. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила mismatched-section-underline-length и …
Ruff no-blank-line-after-section (D410)
no-blank-line-after-section в Ruff проверяет код на предупреждение D410. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила no-blank-line-after-section и …
Ruff no-blank-line-before-section (D411)
no-blank-line-before-section в Ruff проверяет код на предупреждение D411. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила no-blank-line-before-section и …
Ruff blank-lines-between-header-and-content (D412)
blank-lines-between-header-and-content в Ruff проверяет код на предупреждение D412. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила blank-lines-between-header-and-content и …
Ruff missing-blank-line-after-last-section (D413)
missing-blank-line-after-last-section в Ruff проверяет код на предупреждение D413. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила missing-blank-line-after-last-section и …
Ruff empty-docstring-section (D414)
empty-docstring-section в Ruff проверяет код на предупреждение D414. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила empty-docstring-section и …
Ruff missing-terminal-punctuation (D415)
missing-terminal-punctuation в Ruff проверяет код на предупреждение D415. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила missing-terminal-punctuation и …
Ruff missing-section-name-colon (D416)
missing-section-name-colon в Ruff проверяет код на предупреждение D416. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила missing-section-name-colon и …
Ruff undocumented-param (D417)
undocumented-param в Ruff проверяет код на предупреждение D417. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила undocumented-param и …
Ruff overload-with-docstring (D418)
overload-with-docstring в Ruff проверяет код на предупреждение D418. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила overload-with-docstring и …
Ruff empty-docstring (D419)
empty-docstring в Ruff проверяет код на предупреждение D419. Правило относится к группе pydocstyle.
Почему это неправильно
Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.
Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила empty-docstring и …
Ruff undocumented-public-module (D100)
undocumented-public-module проверяет отсутствие документации для публичных модулей.
Почему это неправильно
Публичные модули должны содержать docstring, который описывает их назначение и содержимое. Обычно docstring модуля должен:
- Кратко описывать цель модуля.
- Перечислять экспортируемые классы, исключения, функции и другие объекты с однострочным резюме каждого.
Если модуль используется как скрипт, его docstring должен служить …
Ruff undocumented-public-class (D101)
undocumented-public-class проверяет отсутствие документации для публичных классов.
Почему это неправильно
Публичные классы должны быть документированы с помощью docstring, который описывает их назначение и поведение.
Обычно docstring класса должен:
- Описывать цель класса.
- Перечислять его публичные атрибуты и методы.
Если кодовая база придерживается стандарта оформления docstring для классов (например, NumPy или Google …
Ruff undocumented-public-method (D102)
undocumented-public-method проверяет отсутствие документации для публичных методов.
Почему это неправильно
Публичные методы должны быть документированы с помощью docstring, который описывает их назначение и поведение. Обычно docstring метода должен:
- Описывать поведение метода.
- Перечислять его аргументы.
- Описывать побочные эффекты.
- Указывать возможные исключения.
- Описывать возвращаемые значения.
- Содержать любую другую информацию, важную для пользователя …
Ruff undocumented-public-function (D103)
undocumented-public-function проверяет отсутствие документации для публичных функций.
Почему это неправильно
Публичные функции должны быть документированы с помощью docstring, который описывает их назначение и поведение. Обычно docstring функции должен:
- Описывать поведение функции.
- Перечислять её аргументы.
- Описывать побочные эффекты.
- Указывать возможные исключения.
- Описывать возвращаемые значения.
- Содержать любую другую информацию, важную для пользователя …
