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

Update python_api_reference_vDev.md #667

Closed
wants to merge 1 commit into from

Conversation

tomirendo
Copy link
Contributor

Fixed a typo

Copy link

google-cla bot commented Nov 22, 2023

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@Strilanc
Copy link
Collaborator

Strilanc commented Nov 22, 2023

I agree this is a typo. Thanks for fixing it! However... you've edited it in a generated file, instead of in the source that generates it. That's why the docs-are-fresh check is failing. If you search for

`X_ERROR(0.1)` followed by a `Z_ERROR(0.2)`. This assu

across the entire code base, you'll find the other places it has to change. Technically it only has to change in the one place under the src/ directory, at which point running dev/regen_docs.sh will do all of the others. Though that script assumes you're on a linux machine; maybe you can't run it easily.

(Potentially also interesting to this particular doc string is that the last version of stim introduced code that attempts to do perfect conversions of PAULI_CHANNEL_1 when possible. The given example is still correct because there's no perfect conversion when one of the three probabilities is set to 0. I think it's fine as is.)

@tomirendo
Copy link
Contributor Author

Hey Craig, thanks for responding so quickly! I'll rerun the script and push again.
I should learn to do these things by now.
(Also exciting about the decomposition code, I'll comment that as well)

@Strilanc Strilanc mentioned this pull request Mar 18, 2024
@Strilanc
Copy link
Collaborator

Merged into #721

@Strilanc Strilanc closed this Mar 18, 2024
Strilanc added a commit that referenced this pull request Mar 18, 2024
Merges #667 and
#693 but fixes that they edited
the generated docs instead of the source.

---------

Co-authored-by: Yotam Vaknin <[email protected]>
Co-authored-by: nickdgardner <[email protected]>
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