Skip to content

Improving API docs of inputs to Sampler and Estimator #13969

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

Open
2 tasks
SamFerracin opened this issue Mar 7, 2025 · 4 comments · May be fixed by #14348
Open
2 tasks

Improving API docs of inputs to Sampler and Estimator #13969

SamFerracin opened this issue Mar 7, 2025 · 4 comments · May be fixed by #14348
Assignees
Labels
documentation Something is not clear or an error documentation good first issue Good for newcomers

Comments

@SamFerracin
Copy link
Contributor

SamFerracin commented Mar 7, 2025

Summary

The API docs for some of the methods of Sampler and Estimator have missing hyperlinks. This makes it hard to understand what kind of inputs these functions expect to receive.

Example

The API docs for Sampler.run (link) tells users to provide a SamplerPubLike, but it does not clearly explain what a SamplerPubLike is. By following the typehints on GitHub, you'll notice that SamplerPubLike has its own docstring here, explaining that SamplerPubLike is a union of circuit and BindingsArrayLike. We should expose this docstring in the public API docs. But you'll also notice that BindingsArrayLike is not exposed in the API docs, even though it has its own docstring here. We should expose this too.

Completion criteria

  • Ensure that all the types required by the Sampler and Estimator's methods are documented in the public API docs.
  • Go down the line to ensure that all the types required by these types are also documented.
@SamFerracin SamFerracin added the documentation Something is not clear or an error documentation label Mar 7, 2025
@hillerj1
Copy link

@SamFerracin could i try to fix this? i am fairly new but i think i could do it!

@SamFerracin
Copy link
Contributor Author

@hillerj1 feel free to give this a try 👍

@yaelbh
Copy link
Contributor

yaelbh commented May 12, 2025

@hillerj1 I think I'll do it as my part of my work on #14292. Are you fine with me being assigned to this issue, instead of you?

@yaelbh yaelbh linked a pull request May 12, 2025 that will close this issue
@hillerj1
Copy link

@hillerj1 I think I'll do it as my part of my work on #14292. Are you fine with me being assigned to this issue, instead of you?

Yes that works.

@yaelbh yaelbh assigned yaelbh and unassigned hillerj1 May 12, 2025
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 an error documentation good first issue Good for newcomers
Projects
Status: Tagged but unassigned
Development

Successfully merging a pull request may close this issue.

3 participants