Move plans and stubs from BlueAPI repository #3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
DiamondJoseph
commented
Aug 24, 2023
DiamondJoseph
commented
- Make packages for plans, stubs, tasks with doc strings
- History preserved
* Workaround scanspec serialization issue wtih non-string axes
* Add scan shape to metadata * Fix formatting
… is resolved Resolves #50
* Fix typos in comments/logging * Rename send_and_recieve method to send_and_receive
…an_nd implementation (#294) - Remove fields of metadata duplicated by scan_nd (detectors) - Override incorrect values of metadata set by scan_nd (plan_name, plan_args) - Provide metadata that is available to our implementation but not necessarily for scan_nd (shape) - Rename metadata kwarg to match with Bluesky plans
DiamondJoseph
force-pushed
the
merge_plans
branch
2 times, most recently
from
a2b48de to
805de2d
Compare
callumforrester
requested changes
Aug 29, 2023
|
|
||
| Plans must adhere to BlueAPI's requirements: | ||
| - All arguments type hinted | ||
| - Metadata dict named 'metadata' |
There was a problem hiding this comment.
Do we definitely want this as a hard requirement? If so, there should be some clever test to make sure it's followed.
There was a problem hiding this comment.
Tests for the easily automated requirements added
Codecov Report
@@ Coverage Diff @@
## main #3 +/- ##
=======================================
Coverage ? 87.01%
=======================================
Files ? 9
Lines ? 77
Branches ? 0
=======================================
Hits ? 67
Misses ? 10
Partials ? 0 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
DiamondJoseph
force-pushed
the
merge_plans
branch
3 times, most recently
from
3811de9 to
66c7424
Compare
- Enforce mypy on untyped functions - Add documentation to packages explaining the functionality and requirements of plans, stubs - Use __export__ to explicitly export "standalone" stubs - Add tests to check compliance of plans, stubs to requirements - Ensure loop for 3.10 Future
DiamondJoseph
force-pushed
the
merge_plans
branch
from
66c7424 to
2cb5e9b
Compare
callumforrester
approved these changes
Sep 7, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.