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

Add docstrings to Observable class #2324

Open
jordandsullivan opened this issue Apr 25, 2024 · 1 comment
Open

Add docstrings to Observable class #2324

jordandsullivan opened this issue Apr 25, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation observable

Comments

@jordandsullivan
Copy link
Contributor

jordandsullivan commented Apr 25, 2024

Issue Description

The Observable class lacks docstrings for most of its methods. While some might be considered self-explanatory (depending on a person's background), many are not, such as Observable.partition(). Even short @property functions could still benefit from having fully written out explanations of what the property is.

Proposed Solution

Add descriptive docstrings for each method.

@jordandsullivan jordandsullivan added documentation Improvements or additions to documentation feature-request A request for a feature, tool, or workflow in Mitiq. observable labels Apr 25, 2024
@natestemen natestemen removed the feature-request A request for a feature, tool, or workflow in Mitiq. label Nov 15, 2024
@natestemen
Copy link
Member

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

Documenting these will also ensure they show up in the API-doc!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation observable
Projects
None yet
Development

No branches or pull requests

2 participants