Apply suggestions from code review

Co-authored-by: Julien Gacon <gaconju@gmail.com>
Qiskit · Feb 27, 2023 · 650b3cb · 650b3cb
1 parent d55f95f
commit 650b3cb
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/qiskit/quantum_info/operators/utils.py b/qiskit/quantum_info/operators/utils.py
@@ -57,6 +57,7 @@ def double_commutator(
     a: OperatorTypeT, b: OperatorTypeT, c: OperatorTypeT, *, commutes: bool = True
 ) -> OperatorTypeT:
     r"""Compute symmetric double commutator of a, b and c.
+
     See also Equation (13.6.18) in [1].
 
     If `commutes` is `True`, it returns
@@ -76,12 +77,13 @@ def double_commutator(
         a: Operator a.
         b: Operator b.
         c: Operator c.
-        commutes: True commutes, False anti-commutes.
+        commutes: ``True`` commutes, ``False`` anti-commutes.
 
     Returns:
         The double commutator
 
     References:
+
         [1]: R. McWeeny.
             Methods of Molecular Quantum Mechanics.
             2nd Edition, Academic Press, 1992.

diff --git a/releasenotes/notes/add-commutator-96ef07433e8ca4e7.yaml b/releasenotes/notes/add-commutator-96ef07433e8ca4e7.yaml
@@ -3,4 +3,5 @@ features:
   - |
     Add utility functions :func:`~qiskit.quantum_info.commutator`,
     :func:`~qiskit.quantum_info.anti_commutator`, and
-    :func:`~qiskit.quantum_info.double_commutator`.
+    :func:`~qiskit.quantum_info.double_commutator` to compute commutators
+    for any objects implementing a :class:`.LinearOp`.