Open jordandsullivan opened 6 months ago
To close this issue we should document the following methods.
measure_in
matrix
should be flushed out using the Args: ...
pattern.expectation
partition
from_pauli_string_collections
Documenting these will also ensure they show up in the API-doc!
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 asObservable.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.