Skip to content

Some documentation lints are failing (the CI is failing) #31

Description

@llucax

What happened?

src/frequenz/client/assets/types.py:82:1: DOC602 Class Microgrid: Class docstring contains more class attributes than in actual class attributes. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.)
src/frequenz/client/assets/types.py:82:1: DOC603 Class Microgrid: Class docstring attributes are different from actual class attributes. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Attributes in the class definition but not in the docstring: [delivery_area: DeliveryArea | None, location: Location | None]. Arguments in the docstring but not in the actual class attributes: [country_code: , delivery_area_code: , delivery_area_code_type: , latitude: , longitude: ]. (Please read https://jsh9.github.io/pydoclint/checking_class_attributes.html on how to correctly document class attributes.)

What did you expect instead?

The lints to pass.

Affected version(s)

No response

Affected part(s)

Build script, CI, dependencies, etc. (part:tooling)

Extra information

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority:❓We need to figure out how soon this should be addressedtype:bugSomething isn't working

    Type

    Fields

    Priority

    None yet

    Effort

    None yet

    Affected Version

    None yet

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions