Syntax of `run_plan` in GDA is not clear

[DominicOram]

As a user new to the system it is not clear how to actually call a bluesky plan with args using run_plan in GDA. e.g. I have a plan like

def robot_load(
    puck: int, position: int, robot: Robot = inject("robot")
) -> MsgGenerator[None]:

How do I call this?

1. run_plan("robot_load", {"puck":1, "position":1})
2. run_plan("robot_load", 1, 1)
3. run_plan("robot_load", puck=1, position=1)

3 is correct but if I run help(run_plan) there is no indication of this.

Acceptance Criteria

• help(run_plan) and other docs? Give an example like the above to help a user work out how to call it

[tpoliaw]

https://gerrit.diamond.ac.uk/c/gda/gda-core/+/44721

[DominicOram]

Great, thanks. Is it worth updating https://dev-guide.diamond.ac.uk/athena/tutorials/getting-started/#gda-blueapi-commands too?

[tpoliaw]

Yes - I didn't know those docs were there.

[tpoliaw]

https://gitlab.diamond.ac.uk/sscc-docs/developer-guide/-/merge_requests/261

[abbiemery]

Docs have been updated in the dev-guide, change in GDA is blocked on the changes being documented being approved and merged

[tpoliaw]

GDA docs change now merged