updated docs

[aaronleesander]

Description

This PR updates the examples in the docs based on some mistakes that were noticed.
This type of PR will be done periodicially.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[aaronleesander]

@coderabbitai full review

[coderabbitai]

✅ Action performed

Full review finished.

[coderabbitai]

Warning

Review limit reached

@aaronleesander, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 59 minutes and 47 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate.

For paid Pro and Pro+ PR reviews, CodeRabbit uses rolling per-developer review limits. Reviews become available again as older review attempts age out of the rolling limit window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 9128d2a4-c48e-4828-a8bf-ebc430873466

📥 Commits

Reviewing files that changed from the base of the PR and between a0ebdf3 and 92810b0.

📒 Files selected for processing (33)

• CHANGELOG.md
• docs/conf.py
• docs/examples/analog_simulation.md
• docs/examples/circuit_simulation.md
• docs/examples/custom_gates.md
• docs/examples/ensemble_evolution.md
• docs/examples/equivalence_checking.md
• docs/examples/fermi_hubbard_mpo.md
• docs/examples/hamiltonians.md
• docs/examples/process_tomography.md
• docs/examples/quickstart.md
• docs/examples/realistic_noise_models.md
• docs/examples/representation_comparison.md
• docs/examples/scheduled_jumps.md
• docs/examples/simulation_parameters.md
• docs/examples/simulator_initialization.md
• docs/examples/state_initialization.md
• docs/examples/transmon_emulation.md
• docs/examples/trapped_ion.md
• docs/examples/weak_circuit_simulation.md
• docs/index.md
• docs/references.md
• pyproject.toml
• src/mqt/yaqs/analog/mcwf.py
• src/mqt/yaqs/core/data_structures/noise_model.py
• src/mqt/yaqs/core/methods/tdvp/integrators.py
• src/mqt/yaqs/core/methods/tdvp/primitives.py
• tests/core/data_structures/test_mpo.py
• tests/core/data_structures/test_mps.py
• tests/core/data_structures/test_noise_model.py
• tests/core/methods/test_scheduled_jumps.py
• tests/digital/test_digital_tjm.py
• tests/test_simulator.py

✨ Finishing Touches

✨ Simplify code

• Create PR with simplified code
• Commit simplified code in branch custom-jump

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}