You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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 aSamplerPubLike
, but it does not clearly explain what aSamplerPubLike
is. By following the typehints on GitHub, you'll notice thatSamplerPubLike
has its own docstring here, explaining thatSamplerPubLike
is a union of circuit andBindingsArrayLike
. We should expose this docstring in the public API docs. But you'll also notice thatBindingsArrayLike
is not exposed in the API docs, even though it has its own docstring here. We should expose this too.Completion criteria
The text was updated successfully, but these errors were encountered: