Skip to content

Commit a9d399e

Browse files
authored
Merge pull request #37 from llucax/fix-lint
Move documentation from class to Attributes
2 parents ed5356a + 6af76a4 commit a9d399e

File tree

1 file changed

+15
-16
lines changed

1 file changed

+15
-16
lines changed

src/frequenz/client/assets/types.py

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,7 @@ class Location:
6262

6363
@staticmethod
6464
def from_protobuf(pb: PBLocation) -> "Location":
65-
"""
66-
Create a Location instance from a protobuf message.
65+
"""Create a Location instance from a protobuf message.
6766
6867
Args:
6968
pb: The protobuf Location message.
@@ -85,32 +84,32 @@ class Microgrid:
8584
A microgrid is a localized group of electricity sources and loads that normally
8685
operates connected to and synchronous with the traditional wide area electrical
8786
grid (macrogrid), but is able to disconnect from the grid and operate autonomously.
88-
89-
Attributes:
90-
id: Unique identifier for the microgrid.
91-
enterprise_id: ID of the enterprise that owns this microgrid.
92-
name: Human-readable name for the microgrid.
93-
delivery_area_code: Code identifying the delivery area.
94-
delivery_area_code_type: Type of delivery area code.
95-
latitude: Geographic latitude coordinate.
96-
longitude: Geographic longitude coordinate.
97-
country_code: ISO country code where the microgrid is located.
98-
status: Current operational status of the microgrid.
99-
create_time: Timestamp when the microgrid was created.
10087
"""
10188

10289
id: MicrogridId
90+
"""Unique identifier for the microgrid."""
91+
10392
enterprise_id: EnterpriseId
93+
"""ID of the enterprise that owns this microgrid."""
94+
10495
name: str
96+
"""Human-readable name for the microgrid."""
97+
10598
delivery_area: DeliveryArea | None
99+
"""Delivery area served by the microgrid, if applicable."""
100+
106101
location: Location | None
102+
"""Geographical location of the microgrid, if applicable."""
103+
107104
status: int
105+
"""Current operational status of the microgrid, represented as an integer."""
106+
108107
create_time: datetime
108+
"""Timestamp when the microgrid was created, in UTC."""
109109

110110
@staticmethod
111111
def from_protobuf(pb: PBMicrogrid) -> "Microgrid":
112-
"""
113-
Create a Microgrid instance from a protobuf message.
112+
"""Create a Microgrid instance from a protobuf message.
114113
115114
Args:
116115
pb: The protobuf Microgrid message.

0 commit comments

Comments
 (0)