Ruff undocumented-public-init (D107)

Почему это неправильно

Docstring помогает понять публичный интерфейс и должна быть оформлена так, чтобы её корректно читали люди и инструменты.

Если валидатор показывает это предупреждение, исправьте место, на которое указывает Ruff, ориентируясь на смысл правила undocumented-public-init и пример ниже.

Пример ошибки

class City:
    def __init__(self, name: str, population: int) -> None:
        self.name: str = name
        self.population: int = population

Как правильно

class City:
    def __init__(self, name: str, population: int) -> None:
        """Initialize a city with a name and population."""
        self.name: str = name
        self.population: int = population

Автоисправление

Ruff не предлагает автоисправление для этого правила.