Skip to content

Commit 44206d1

Browse files
committed
chore: Improve doc string readability and grammar
1 parent 1725f4a commit 44206d1

File tree

1 file changed

+3
-7
lines changed

1 file changed

+3
-7
lines changed

roborock/devices/v1_channel.py

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,7 @@
5858

5959
@dataclass(frozen=True)
6060
class RpcStrategy:
61-
"""Strategy for sending RPC commands over a specific channel.
62-
63-
This holds the configuration for a specific transport method that differ
64-
in how messages are encoded/decoded and which channel is used.
65-
"""
61+
"""Strategy for encoding/sending/decoding RPC commands."""
6662

6763
name: str # For debug logging
6864
channel: LocalChannel | MqttChannel
@@ -72,7 +68,7 @@ class RpcStrategy:
7268

7369

7470
class RpcChannel(V1RpcChannel):
75-
"""Provides a synchronous RPC interface around a transport channel."""
71+
"""Provides an RPC interface around a pub/sub transport channel."""
7672

7773
def __init__(self, rpc_strategies: list[RpcStrategy]) -> None:
7874
"""Initialize the RpcChannel with on ordered list of strategies."""
@@ -215,7 +211,7 @@ def is_mqtt_connected(self) -> bool:
215211

216212
@property
217213
def rpc_channel(self) -> V1RpcChannel:
218-
"""Return the combined RPC channel prefers local with a fallback to MQTT."""
214+
"""Return the combined RPC channel that prefers local with a fallback to MQTT."""
219215
strategies = []
220216
if local_rpc_strategy := self._create_local_rpc_strategy():
221217
strategies.append(local_rpc_strategy)

0 commit comments

Comments
 (0)