From b672c3c2a7325b4182c04c894cd1dd6488d9b62b Mon Sep 17 00:00:00 2001 From: Julian Stirling Date: Wed, 6 Aug 2025 11:48:06 +0000 Subject: [PATCH] Clarify docstring for Simulation start_streaming --- .../things/camera/simulation.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/src/openflexure_microscope_server/things/camera/simulation.py b/src/openflexure_microscope_server/things/camera/simulation.py index c6f30007..a453fb3a 100644 --- a/src/openflexure_microscope_server/things/camera/simulation.py +++ b/src/openflexure_microscope_server/things/camera/simulation.py @@ -224,8 +224,13 @@ class SimulatedCamera(BaseCamera): ) -> None: """Start the live stream. - This should be used to adjust the resolution the simulation doesn't yet do - this. + The start_streaming method is used a camera ``Thing`` to begin streaming + images or to adjust the stream resolution if streaming is already active. + + The simulation camera does not currently support the resolution argument. + It will always issue a warning that the resolution is not respected. + If called while already streaming, the warning will be emitted and no other + action will be taken. """ logging.warning( f"Simulation camera doesn't respect {main_resolution=} or {buffer_count=} "