search

quantumlib / Stim

A fast stabilizer circuit library.
Apache License 2.0
318 stars 93 forks source link

Update python_api_reference_vDev.md #667

Closed tomirendo closed 5 months ago

tomirendo commented 9 months ago

Fixed a typo

google-cla[bot] commented 9 months ago

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 commented 9 months ago

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 commented 9 months ago

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 commented 5 months ago

Merged into https://github.com/quantumlib/Stim/pull/721