From 7727d0a51d2328aba9d0b900c8364ee0bc0632d9 Mon Sep 17 00:00:00 2001 From: Julian Stirling Date: Thu, 7 Aug 2025 12:06:58 +0100 Subject: [PATCH] Update language in BaseStitcher to clarify that the stitching uses subprocess not threading --- src/openflexure_microscope_server/stitching.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/openflexure_microscope_server/stitching.py b/src/openflexure_microscope_server/stitching.py index 54b367f9..46c3e9c0 100644 --- a/src/openflexure_microscope_server/stitching.py +++ b/src/openflexure_microscope_server/stitching.py @@ -47,8 +47,10 @@ class BaseStitcher: """A base stitching class for all stitchers. Don't initialise this directly. The base class has no way to run the command. Child classes should either implement - a ``start``, ``running``, and ``wait`` methods if they stitch in a thread, or ``run`` - if they stitch in this thread and return once complete. + a ``start``, ``running``, and ``wait`` methods if return after starting the + subprocess and can be polled or waited on like a thread; or ``run`` if the + the function blocks while the stitching subprocess is ongoing and return once + complete. """ def __init__(self, images_dir: str, *, overlap: float, correlation_resize: float):