Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

run_options is poorly documented #2083

Open
kevinsung opened this issue Mar 13, 2024 · 3 comments
Open

run_options is poorly documented #2083

kevinsung opened this issue Mar 13, 2024 · 3 comments
Labels
documentation Something is not clear or error in description

Comments

@kevinsung
Copy link

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

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

@kevinsung
Copy link
Author

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

@abbycross
Copy link

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 🤦

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something is not clear or error in description
Projects
None yet
Development

No branches or pull requests

2 participants