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

Correct format in API-doc for two calibration methods #2517

Closed
bdg221 opened this issue Sep 26, 2024 · 0 comments · Fixed by #2571
Closed

Correct format in API-doc for two calibration methods #2517

bdg221 opened this issue Sep 26, 2024 · 0 comments · Fixed by #2571
Assignees
@bdg221
Labels
bug Something isn't working calibration documentation Improvements or additions to documentation non-quantum Requires no knowledge of quantum physics to fix / work on.

Comments

@bdg221
Copy link
Collaborator

bdg221 commented Sep 26, 2024

The API-docs do include log_results_cartesian() and log_results_flat() though the example output is mangled and not a good representation.

image
image

In the actual source code, the example output is perfect for both.
image
image
@bdg221 bdg221 added bug Something isn't working documentation Improvements or additions to documentation non-quantum Requires no knowledge of quantum physics to fix / work on. calibration labels Sep 26, 2024
@bdg221 bdg221 self-assigned this Sep 26, 2024
@bdg221 bdg221 mentioned this issue Nov 13, 2024
Merged
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bdg221 bdg221

Labels
bug Something isn't working calibration documentation Improvements or additions to documentation non-quantum Requires no knowledge of quantum physics to fix / work on.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update Calibrator method docstrings for formatting bdg221/mitiq_bg
1 participant
@bdg221