Правила Ruff, связанные с pydocstyle (D)
Правила Ruff, связанные с pydocstyle. Подробнее об этом плагине на его странице PyPI
Часть категории Правила проверок кода в Ruff.
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 функции должен:
- Описывать поведение функции.
- Перечислять её аргументы.
- Описывать побочные эффекты.
- Указывать возможные исключения.
- Описывать возвращаемые значения.
- Содержать любую другую информацию, важную для пользователя …
