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.

Sign up for GitHub

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

Jump to bottom

Observable class missing methods in API-doc #2524

Open
natestemen opened this issue Oct 2, 2024 · 1 comment
Open

Observable class missing methods in API-doc #2524

natestemen opened this issue Oct 2, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation observable

Comments

@natestemen
Copy link
Member

Currently, the only method of Observable which is displaying in our API-doc is matrix. Not sure why this is, but the class has many other handy methods which should also be displayed!

Links
@natestemen
Copy link
Member Author

So the reason the many other methods are not appearing in the API-doc is that they are not documented! To close this issue we should document the following methods.

  1. measure_in
  2. The arguments of matrix should be flushed out using the Args: ... pattern.
  3. expectation
  4. partition
  5. from_pauli_string_collections

@cosenal cosenal added the documentation Improvements or additions to documentation label Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation observable
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@cosenal @natestemen