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.

Sign up for GitHub

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

Jump to bottom

Screencast in doc main page shows wrong option for calibration logs #2592

Open
cosenal opened this issue Dec 2, 2024 · 0 comments
Open

Screencast in doc main page shows wrong option for calibration logs #2592

cosenal opened this issue Dec 2, 2024 · 0 comments
Assignees
@natestemen
Labels
calibration documentation Improvements or additions to documentation

Comments

@cosenal
Copy link
Contributor

cosenal commented Dec 2, 2024 •
edited
Loading

The screencast in the https://mitiq.readthedocs.io/en/stable/index.html#calibration shows that the following option as working:

cal = Calibrator(execute, frontend="cirq")
cal.run(log=True)  # <-- bad option for arg log

However, the log arg of run() doesn't accept a Boolean value, but only a value from the OutputForm enum.

Doc should be fixed accordingly.
@cosenal cosenal added documentation Improvements or additions to documentation calibration labels Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@natestemen natestemen

Labels
calibration documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@cosenal @natestemen