blender/flamenco
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add-on: document timeout parameter of PackThread.poll()

Browse Source 
The timeout should be specified in seconds, which wasn't documented before.

No functional changes.
This commit is contained in:
Sybren A. Stüvel 2024-06-25 12:10:28 +02:00
parent c41eda4a09
commit 152adcb777
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
addon/flamenco/bat/interface.py
View File

@ -180,9 +180,9 @@ class PackThread(threading.Thread):
def poll(self, timeout: Optional[int] = None) -> Optional[Message]: def poll(self, timeout: Optional[int] = None) -> Optional[Message]:
"""Poll the queue, return the first message or None if there is none. """Poll the queue, return the first message or None if there is none.
:param timeout: Max time to wait for a message to appear on the queue. :param timeout: Max time to wait for a message to appear on the queue,
If None, will not wait and just return None immediately (if there is in seconds. If None, will not wait and just return None immediately
no queued message). (if there is no queued message).
""" """
try: try:
return self.queue.get(block=timeout is not None, timeout=timeout) return self.queue.get(block=timeout is not None, timeout=timeout)