From 6b96fd3574fa29ed700206e4873e44e401e4d912 Mon Sep 17 00:00:00 2001 From: Peter Holloway Date: Fri, 24 Apr 2026 15:54:24 +0100 Subject: [PATCH 1/3] docs: Mention need for stomp config in run subcommand --- src/blueapi/cli/cli.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/blueapi/cli/cli.py b/src/blueapi/cli/cli.py index bd2154f0a..caaced913 100644 --- a/src/blueapi/cli/cli.py +++ b/src/blueapi/cli/cli.py @@ -337,7 +337,12 @@ def run_plan( instrument_session: str, parameters: TaskParameters, ) -> None: - """Run a plan with parameters""" + """Run a plan with parameters + + To run in the foreground and to block until it is complete, stomp + configuration is required. Without stomp configuration, `--bg` can be used + to start a plan in the background. + """ client = cast(BlueapiClient, obj["client"]) task = TaskRequest( From 5a09116942943ed2384b0333a3caf23e301ea673 Mon Sep 17 00:00:00 2001 From: Peter Holloway Date: Fri, 24 Apr 2026 15:58:42 +0100 Subject: [PATCH 2/3] Use correct quotes --- src/blueapi/cli/cli.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/blueapi/cli/cli.py b/src/blueapi/cli/cli.py index caaced913..1be6db622 100644 --- a/src/blueapi/cli/cli.py +++ b/src/blueapi/cli/cli.py @@ -340,7 +340,7 @@ def run_plan( """Run a plan with parameters To run in the foreground and to block until it is complete, stomp - configuration is required. Without stomp configuration, `--bg` can be used + configuration is required. Without stomp configuration, '--bg' can be used to start a plan in the background. """ From 06bf854ba272afbfb85d5c58053fd26ff14e544d Mon Sep 17 00:00:00 2001 From: Peter Holloway Date: Fri, 24 Apr 2026 16:38:47 +0100 Subject: [PATCH 3/3] del to --- src/blueapi/cli/cli.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/blueapi/cli/cli.py b/src/blueapi/cli/cli.py index 1be6db622..2c150f805 100644 --- a/src/blueapi/cli/cli.py +++ b/src/blueapi/cli/cli.py @@ -339,7 +339,7 @@ def run_plan( ) -> None: """Run a plan with parameters - To run in the foreground and to block until it is complete, stomp + To run in the foreground and block until it is complete, stomp configuration is required. Without stomp configuration, '--bg' can be used to start a plan in the background. """