Skip to content

Commit 8820bbe

Browse files
authored
docs: Mention need for stomp config in run subcommand (#1515)
1 parent 74bbcf0 commit 8820bbe

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

src/blueapi/cli/cli.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -337,7 +337,12 @@ def run_plan(
337337
instrument_session: str,
338338
parameters: TaskParameters,
339339
) -> None:
340-
"""Run a plan with parameters"""
340+
"""Run a plan with parameters
341+
342+
To run in the foreground and block until it is complete, stomp
343+
configuration is required. Without stomp configuration, '--bg' can be used
344+
to start a plan in the background.
345+
"""
341346

342347
client = cast(BlueapiClient, obj["client"])
343348
task = TaskRequest(

0 commit comments

Comments
 (0)