Skip to content

Commit 248c221

Browse files
committed
Fix return docstring...
1 parent 5ea87af commit 248c221

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

canalystii/device.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ def flush_tx_buffer(self, channel, timeout=0):
125125
:param channel: Channel (0 or 1) to flush the TX buffer on.
126126
:param timeout: Optional number of seconds to continue polling for empty TX buffer. If 0 (default),
127127
this function will immediately return the current status of the send buffer.
128-
:return True if flush is successful (no pending messages to send), False if flushing timed out.
128+
:return: True if flush is successful (no pending messages to send), False if flushing timed out.
129129
"""
130130
deadline = None
131131
while deadline is None or time.time() < deadline:
@@ -234,7 +234,7 @@ def receive(self, channel):
234234
"""Poll the hardware for received CAN messages and return them all as a list.
235235
236236
:param channel: Channel (0 or 1) to poll. The channel must be started.
237-
:return List of Message objects representing received CAN messages, in order.
237+
:return: List of Message objects representing received CAN messages, in order.
238238
"""
239239
if not self._initialized[channel]:
240240
raise RuntimeError(f"Channel {channel} is not initialized.")
@@ -287,7 +287,7 @@ def send(self, channel, messages, flush_timeout=None):
287287
for the buffer state. If None (default) then the function returns immediately,
288288
when some CAN messages may still be waiting to sent due to CAN bus arbitration.
289289
See flush_tx_buffer() function for details.
290-
:return None if flush_timeout is None (default). Otherwise True if all messages sent
290+
:return: None if flush_timeout is None (default). Otherwise True if all messages sent
291291
(or failed), False if timeout reached.
292292
"""
293293
if not self._initialized[channel]:
@@ -312,7 +312,7 @@ def send(self, channel, messages, flush_timeout=None):
312312
def get_can_status(self, channel):
313313
"""Return some internal CAN-related values. The actual meaning of these is currently unknown.
314314
315-
:return Instance of the CANStatusResponse structure. Note the field names may not be accurate.
315+
:return: Instance of the CANStatusResponse structure. Note the field names may not be accurate.
316316
"""
317317
if not self._initialized[channel]:
318318
logger.warning(

0 commit comments

Comments
 (0)