DiamondLightSource / DiamondLightSource/blueapi

Documentation: More detail on valid plan parameters and how to type various constructions

Open
#951 0 comments 1 reaction 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
13
Forks
13
Avg merge
2d 11h
Merged PRs (30d)
25

Description

The documentation [on allowed data types](https://github.com/DiamondLightSource/blueapi/blob/main/docs/explanations/plans.md#allowed-argument-types) defers a lot of explanation to the pydantic documentation, which doesn't mention about nested models (in that section, it does [elsewhere](https://docs.pydantic.dev/dev/concepts/models/#nested-models)) and does not provide any examples of how that maps to the `params` that are passed to run the plan.

This has led to uncertainty about what is supported. These docs should be improved and more examples given, including a fully worked example of writing a plan with nested parameters.

## Acceptance Criteria
- The docs are sufficient for someone new to writing bluesky plans to be able to know how to support their use case

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.