Qiskit / qiskit-aer

Aer is a high performance simulator for quantum circuits that includes noise models
https://qiskit.github.io/qiskit-aer/
Apache License 2.0
465 stars 354 forks source link

run_options is poorly documented #2083

Open kevinsung opened 3 months ago

kevinsung commented 3 months ago

Example: https://qiskit.github.io/qiskit-aer/stubs/qiskit_aer.primitives.Sampler.html

The documentation of run_options simply says either "Options passed to run." or "Backend runtime options used for circuit execution."

abbycross commented 2 months ago

Should this be opened in the aer repo, or @kevinsung do you want better documentation in the Platform docs around run_options?

kevinsung commented 2 months ago

I think the Aer repo (where this issue currently exists) is appropriate since this is an API docs issue.

abbycross commented 2 months ago

Oh haha my bad, I clicked on the link to get here from the docs repo and didn't even notice it took me to the aer repo 🤦