Skip to content

Commit 9078b14

Browse files
committed
Cleanup and correct doc strings
1 parent d24a45e commit 9078b14

File tree

5 files changed

+5
-7
lines changed

5 files changed

+5
-7
lines changed

plugwise_usb/connection/manager.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ async def setup_connection_to_stick(
183183
self._subscribe_to_stick_events()
184184

185185
async def write_to_stick(self, request: PlugwiseRequest) -> None:
186-
"""Write message to USB stick. Returns the updated request object."""
186+
"""Write message to USB stick."""
187187
if not request.resend:
188188
raise StickError(
189189
f"Failed to send {request.__class__.__name__} " +

plugwise_usb/connection/queue.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ async def submit(
121121
)
122122

123123
async def _add_request_to_queue(self, request: PlugwiseRequest) -> None:
124-
"""Add request to send queue and return the session id."""
124+
"""Add request to send queue."""
125125
await self._submit_queue.put(request)
126126
if self._submit_worker_task is None or self._submit_worker_task.done():
127127
self._submit_worker_task = self._loop.create_task(

plugwise_usb/messages/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ def __init__(self, identifier: bytes) -> None:
2121

2222
@property
2323
def seq_id(self) -> bytes | None:
24-
"""Return sequence id assigned to this request."""
24+
"""Return sequence id."""
2525
return self._seq_id
2626

2727
@seq_id.setter

plugwise_usb/messages/responses.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -384,7 +384,7 @@ class NodeImageValidationResponse(PlugwiseResponse):
384384
"""
385385

386386
def __init__(self) -> None:
387-
"""Initialize NodePingResponse message object."""
387+
"""Initialize NodeImageValidationResponse message object."""
388388
super().__init__(b"0010")
389389
self.image_timestamp = UnixTimestamp(0)
390390
self._params += [self.image_timestamp]

plugwise_usb/network/__init__.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -364,10 +364,8 @@ async def get_node_details(
364364
"""Return node discovery type."""
365365
ping_response: NodePingResponse | None = None
366366
if ping_first:
367-
# Define ping request with custom timeout
367+
# Define ping request with one retry
368368
ping_request = NodePingRequest(bytes(mac, UTF8), retries=1)
369-
# ping_request.timeout = 3
370-
371369
ping_response: NodePingResponse | None = (
372370
await self._controller.send(
373371
ping_request

0 commit comments

Comments
 (0)