Skip to content

Commit ca41f6c

Browse files
Update docstring for notify_new_frame
1 parent febdac5 commit ca41f6c

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/labthings_fastapi/outputs/mjpeg_stream.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,10 @@ def add_frame(self, frame: bytes, portal: BlockingPortal) -> None:
204204
portal.start_task_soon(self.notify_new_frame, entry.index)
205205

206206
async def notify_new_frame(self, i: int) -> None:
207-
"""Notify any waiting tasks that a new frame is available"""
207+
"""Notify any waiting tasks that a new frame is available.
208+
209+
:param i: The number of the frame (which counts up since the server starts)
210+
"""
208211
async with self.condition:
209212
self.last_frame_i = i
210213
self.condition.notify_all()

0 commit comments

Comments
 (0)