-
Notifications
You must be signed in to change notification settings - Fork 6
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
Minimal docs to missing experiments #1016
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1016 +/- ##
=======================================
Coverage 97.50% 97.50%
=======================================
Files 124 124
Lines 9833 9833
=======================================
Hits 9588 9588
Misses 245 245
Flags with carried forward coverage won't be shown. Click here to find out more. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nothing serious. For me, it's even fine to merge.
However, assuming @hay-k is right, and the information is already contained in the docstrings (I didn't check explicitly, but I trust him), I'd say that there are two options:
- improve the description in the docs, and drop the current docstring (we'll delegate more in-depth explanations to the docs)
- drop the description from the docs, postponing the problem (as for the other protocols here) - the docstring will remain available anyhow
After a discussion with @hay-k , we agreed to remove the docs for the coupler qubit/resonator spectroscopy because it is not fully clear the purposes and results of these experiments. We will eventually add them after an investigation. |
Co-authored-by: Alessandro Candido <candido.ale@gmail.com>
Checklist:
master
main
main