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

Introduce InstrumentModule as a superclass of InstrumentChannel #3840

Merged
merged 4 commits into from
Jan 19, 2022

Conversation

jenshnielsen
Copy link
Collaborator

@jenshnielsen jenshnielsen commented Jan 19, 2022

And clarify (via typing) that submodule in an instrument must be either InstrumentModules or ChannelLists

Open questions:

  • Should we retype ChannelList and friends to allow InstrumentModule as a type. Not right now. We may add more channel specific functionality to InstrumentChannel down the line
  • Update docs

@codecov
Copy link

codecov bot commented Jan 19, 2022

Codecov Report

Merging #3840 (c7e98d3) into master (11c7614) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master    #3840   +/-   ##
=======================================
  Coverage   65.57%   65.57%           
=======================================
  Files         227      227           
  Lines       30641    30643    +2     
=======================================
+ Hits        20093    20095    +2     
  Misses      10548    10548           

Copy link
Contributor

@astafan8 astafan8 left a comment

Choose a reason for hiding this comment

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

Should we retype ChannelList and friends to allow InstrumentModule as a type

hmm. so that channellist may contain instrument modules, not just instrument channels? if so, then i'd probably wait with that since i can't think of an instrument were i'd want to have a channel list of non-channels, e.g. of things/modules that don't have a port on the panel of the instrument.

Update docs

yes! :)

also need to add a newsfragment :)

@jenshnielsen
Copy link
Collaborator Author

@astafan8 Thanks docs are updated and newsfragment added

@jenshnielsen jenshnielsen merged commit 0d1422e into microsoft:master Jan 19, 2022
@jenshnielsen jenshnielsen deleted the instrument_module branch January 19, 2022 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants