Skip to content

documentation: fix typos, broken links and docstrings that don't match the code - #1360

Merged
rmshaffer merged 2 commits into
amazon-braket:mainfrom
moneytosms:documentation/fix-typos-links-docstrings
Sep 30, 2026
Merged

rmshaffer merged 2 commits into
amazon-braket:mainfrom
moneytosms:documentation/fix-typos-links-docstrings

Conversation

@moneytosms

Copy link
Copy Markdown
Contributor

Issue #, if available:

Closes #1359

Description of changes:

Docs-only fixes. No behavior changes.

  • Typos in docstrings and comments across aws, circuits, emulation, jobs, ahs, pulse, timings and tracking
  • Docstrings that didn't match the code:
    • Ry.ry() / Rz.rz() return descriptions said "Rx instruction"
    • PhaseFlip formula used X instead of Z
    • ECR matrix was missing the 1/sqrt(2) factor
    • TwoQubitPauliChannel and Kraus diagram symbols (PC2, KR)
    • copy_checkpoints_from_job was referred to as use_checkpoints_from_job
    • to_dict docstrings in the noise model criteria classes described from_dict
    • ObservableCriteria.from_dict said GateCriteria
    • UnitaryGateCriteria and PauliString.power list TypeError, which is what the code raises
    • PauliString and AnalogHamiltonianSimulation docstrings said "circuit"
    • measurements_from_measurement_probabilities return description was copied from the method above it
  • Docstring examples that wouldn't run (ResultType.Probabilities, *Modifier classes in emulation passes, missing comma in FreeParameter, extra parenthesis in Instruction, apply_readout_noise example calling apply_initialization_noise)
  • to_time_traces() to to_time_trace() in the cheat sheet (en and fr) and genai_cheat_sheet.md
  • README: example paths, pip install -e ".[test]", hybrid job wording in the SV1 example, a malformed console link
  • CONTRIBUTING: AWS CLI setup link pointed to Amazon Polly docs, updated old help.github.com links
  • Cheat sheet footer source link returned 404

Testing done:

  • tox -e linters
  • tox -e docs (same warning count as main)
  • tox -e unit-tests
  • verify_snippets.py and generate_genai_cheat_sheet.py --check for the cheat sheet
  • Checked the new links return 200

Merge Checklist

Put an x in 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

  • I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • I have checked that my tests are not configured for a specific region or account (if appropriate)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@moneytosms
moneytosms requested a review from a team as a code owner September 29, 2026 02:16
@github-actions github-actions Bot added documentation Improvements or additions to documentation quantum-programs circuits devices aws labels Sep 29, 2026
@codecov

codecov Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (fbe1b47) to head (8c8c0af).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@rmshaffer rmshaffer left a comment •

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @moneytosms for taking the initiative to fix all of these! This is a nice step toward cleaner and more correct documentation.

@rmshaffer
rmshaffer merged commit bbb7bba into amazon-braket:main Sep 30, 2026
20 checks passed
@moneytosms

Copy link
Copy Markdown
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

aws circuits devices documentation Improvements or additions to documentation quantum-programs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Typos and docstrings that don't match the code

2 participants