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

Minimal docs to missing experiments #1016

Merged
merged 7 commits into from
Oct 29, 2024
Merged

Minimal docs to missing experiments #1016

merged 7 commits into from
Oct 29, 2024

Conversation

Edoardo-Pedicillo
Copy link
Contributor

Checklist:

  • Reviewers confirm new code works as expected.
  • Tests are passing.
  • Coverage does not decrease.
  • Documentation is updated.
  • Compatibility with Qibo modules (Please edit this section if the current pull request is not compatible with the following branches).
    • Qibo: master
    • Qibolab: main
    • Qibolab_platforms_qrc: main

Copy link

codecov bot commented Oct 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.50%. Comparing base (dc66a50) to head (301a571).
Report is 12 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1016   +/-   ##
=======================================
  Coverage   97.50%   97.50%           
=======================================
  Files         124      124           
  Lines        9833     9833           
=======================================
  Hits         9588     9588           
  Misses        245      245           
Flag Coverage Δ
unittests 97.50% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

see 3 files with indirect coverage changes

@Edoardo-Pedicillo Edoardo-Pedicillo added this to the Qibocal 0.1.1 milestone Oct 18, 2024
@Edoardo-Pedicillo Edoardo-Pedicillo marked this pull request as ready for review October 21, 2024 13:02
Copy link
Member

@alecandido alecandido left a 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:

  1. improve the description in the docs, and drop the current docstring (we'll delegate more in-depth explanations to the docs)
  2. drop the description from the docs, postponing the problem (as for the other protocols here) - the docstring will remain available anyhow

@Edoardo-Pedicillo
Copy link
Contributor Author

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.

@Edoardo-Pedicillo Edoardo-Pedicillo changed the base branch from clean_runcards to main October 28, 2024 13:23
@Edoardo-Pedicillo Edoardo-Pedicillo linked an issue Oct 28, 2024 that may be closed by this pull request
29 tasks
@Edoardo-Pedicillo Edoardo-Pedicillo added this pull request to the merge queue Oct 29, 2024
Merged via the queue into main with commit cace06e Oct 29, 2024
21 checks passed
@Edoardo-Pedicillo Edoardo-Pedicillo deleted the docs branch October 29, 2024 12:09
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.

Protocols docs
3 participants