Skip to content

Commit b3aa245

Browse files
committed
Comment in periodic send
1 parent df8030d commit b3aa245

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

can/bus.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,15 @@ def send_periodic(self, msg, period, duration=None):
7373
:param float duration:
7474
The duration to keep sending this message at given rate. If
7575
no duration is provided, the task will continue indefinitely.
76+
7677
:return: A started task instance
7778
:rtype: can.CyclicSendTaskABC
79+
80+
Note the duration before the message stops being sent may not
81+
be exactly the same as the duration specified by the user. In
82+
general the message will be sent at the given rate until at
83+
least *duration* seconds.
84+
7885
"""
7986
return ThreadBasedCyclicSendTask(self, msg, period, duration)
8087

0 commit comments

Comments
 (0)