Repository navigation
documentation: fix typos, broken links and docstrings that don't match the code - #1360
Merged
rmshaffer merged 2 commits intoSep 30, 2026
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1360 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 171 171
Lines 11667 11667
Branches 1539 1539
=========================================
Hits 11667 11667 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
rmshaffer
approved these changes
Sep 30, 2026
Member
There was a problem hiding this comment.
Thank you @moneytosms for taking the initiative to fix all of these! This is a nice step toward cleaner and more correct documentation.
Contributor
Author
|
You're welcome @rmshaffer . This is my first contribution to braket and I just wanted to start out with something simple yet important. I'm looking forward to finding more meaningful ways to contribute to open-source quantum. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
Closes #1359
Description of changes:
Docs-only fixes. No behavior changes.
aws,circuits,emulation,jobs,ahs,pulse,timingsandtrackingRy.ry()/Rz.rz()return descriptions said "Rx instruction"PhaseFlipformula used X instead of ZECRmatrix was missing the 1/sqrt(2) factorTwoQubitPauliChannelandKrausdiagram symbols (PC2,KR)copy_checkpoints_from_jobwas referred to asuse_checkpoints_from_jobto_dictdocstrings in the noise model criteria classes describedfrom_dictObservableCriteria.from_dictsaidGateCriteriaUnitaryGateCriteriaandPauliString.powerlistTypeError, which is what the code raisesPauliStringandAnalogHamiltonianSimulationdocstrings said "circuit"measurements_from_measurement_probabilitiesreturn description was copied from the method above itResultType.Probabilities,*Modifierclasses in emulation passes, missing comma inFreeParameter, extra parenthesis inInstruction,apply_readout_noiseexample callingapply_initialization_noise)to_time_traces()toto_time_trace()in the cheat sheet (en and fr) andgenai_cheat_sheet.mdpip install -e ".[test]", hybrid job wording in the SV1 example, a malformed console linkTesting done:
tox -e linterstox -e docs(same warning count as main)tox -e unit-testsverify_snippets.pyandgenerate_genai_cheat_sheet.py --checkfor the cheat sheetMerge Checklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.General
Tests
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.