Document additional use and show an example session #28
Conversation
Pull Request Test Coverage Report for Build 12182812027Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
docs/source/guides/dm.md
Outdated
| ## Example session | ||
|
|
||
| Let's work through an example session at an APS beamline. The instrument | ||
| package is named `mic_instrument`. Start a new console session: |
There was a problem hiding this comment.
let's make this generalized to our package
There was a problem hiding this comment.
The instructions above are the generality. The Example session section can be dropped from this repo.
There was a problem hiding this comment.
See commit e52d198.
docs/source/guides/dm.md
Outdated
There was a problem hiding this comment.
This seems useful, however I believe we are tending back to the monolith structure that has cause bluesky_training to be hard to use. Let's keep documentation of the package exclusively to bs_model_instrument, and instead add aspects such as these to v2 of bluesky training. I think it is important to not have scope creep happen and keep packages/repositories focused on solving 1 problem.
|
Ready for review again. |
Example session starts here: https://github.com/BCDA-APS/bs_model_instrument/blob/27-dm_plans_docs/docs/source/guides/dm.md#example-session-1