Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document additional use and show an example session #28

Merged
merged 4 commits into from
Dec 5, 2024

Conversation

prjemian
Copy link
Collaborator

@prjemian prjemian commented Nov 20, 2024

@prjemian prjemian added the documentation Improvements or additions to documentation label Nov 20, 2024
@prjemian prjemian self-assigned this Nov 20, 2024
@coveralls
Copy link

coveralls commented Nov 20, 2024

Pull Request Test Coverage Report for Build 12182812027

Warning: 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

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 3 unchanged lines in 1 file lost coverage.
  • Overall coverage decreased (-0.4%) to 79.45%

Files with Coverage Reduction New Missed Lines %
src/instrument/utils/controls_setup.py 3 67.5%
Totals Coverage Status
Change from base Build 11939808433: -0.4%
Covered Lines: 433
Relevant Lines: 545

💛 - Coveralls

## 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:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's make this generalized to our package

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The instructions above are the generality. The Example session section can be dropped from this repo.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See commit e52d198.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@prjemian
Copy link
Collaborator Author

prjemian commented Dec 5, 2024

Ready for review again.

@prjemian prjemian merged commit 2516240 into main Dec 5, 2024
5 checks passed
@prjemian prjemian deleted the 27-dm_plans_docs branch December 5, 2024 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

update dm_plans documentation
3 participants