Skip to content

Commit ea7dcf5

Browse files
committed
Fit one-line docstrings in one line.
Also do some rephrasing as needed. Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 9b54403 commit ea7dcf5

File tree

10 files changed

+12
-28
lines changed

10 files changed

+12
-28
lines changed

tests/actor/test_data_sourcing.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
# License: MIT
22
# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
33

4-
"""
5-
Tests for the DataSourcingActor.
6-
"""
4+
"""Tests for the DataSourcingActor."""
75

86
from frequenz.api.common import components_pb2 as components_pb
97
from frequenz.channels import Broadcast

tests/microgrid/test_client.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
# License: MIT
22
# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
33

4-
"""
5-
Tests for the microgrid client thin wrapper.
6-
"""
4+
"""Tests for the microgrid client thin wrapper."""
75

86
import asyncio
97

tests/microgrid/test_component.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
# License: MIT
22
# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
33

4-
"""
5-
Tests for the microgrid component wrapper.
6-
"""
4+
"""Tests for the microgrid component wrapper."""
75

86
import frequenz.api.common.components_pb2 as components_pb
97
import pytest

tests/microgrid/test_component_data.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
# License: MIT
22
# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
33

4-
"""
5-
Tests for the microgrid component data.
6-
"""
4+
"""Tests for the microgrid component data."""
75

86
from datetime import datetime, timezone
97

tests/microgrid/test_connection.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
# License: MIT
22
# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
33

4-
"""
5-
Tests for the microgrid Connection type.
6-
"""
4+
"""Tests for the microgrid Connection type."""
75

86
from frequenz.sdk.microgrid import client
97

tests/microgrid/test_graph.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
# License: MIT
22
# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
33

4-
"""
5-
Tests for the microgrid component graph.
6-
"""
4+
"""Tests for the microgrid component graph."""
75

86
# pylint: disable=too-many-lines,use-implicit-booleaness-not-comparison
97
# pylint: disable=invalid-name,missing-function-docstring,too-many-statements

tests/microgrid/test_grid.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
# License: MIT
22
# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
33

4-
"""
5-
Tests for the `Grid` module.
6-
"""
4+
"""Tests for the `Grid` module."""
75

86
from frequenz.sdk import microgrid
97
from frequenz.sdk.microgrid.component import Component, ComponentCategory, GridMetadata

tests/microgrid/test_mock_api.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
# License: MIT
22
# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
33

4-
"""
5-
Tests for the microgrid mock api.
6-
"""
4+
"""Tests for the microgrid mock api."""
75

86
# pylint: disable=missing-function-docstring,use-implicit-booleaness-not-comparison
97
# pylint: disable=invalid-name,no-name-in-module,no-member

tests/timeseries/test_moving_window.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ def fake_time() -> Iterator[time_machine.Coordinates]:
3838
async def push_logical_meter_data(
3939
sender: Sender[Sample[Quantity]], test_seq: Sequence[float]
4040
) -> None:
41-
"""
42-
Push data in the passed sender to mock `LogicalMeter` behaviour.
41+
"""Push data in the passed sender to mock `LogicalMeter` behaviour.
42+
4343
Starting with the First of January 2023.
4444
4545
Args:

tests/timeseries/test_ringbuffer.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -393,8 +393,8 @@ def test_cleanup_oldest_gap_timestamp() -> None:
393393

394394

395395
def test_delete_oudated_gap() -> None:
396-
"""
397-
Update the buffer such that the gap is no longer valid.
396+
"""Test updating the buffer such that the gap is no longer valid.
397+
398398
We introduce two gaps and check that the oldest is removed.
399399
"""
400400
buffer = OrderedRingBuffer(

0 commit comments

Comments
 (0)