docs: include LabelT in base interface docs

qiskit-community · Jun 28, 2024 · 112f695 · 112f695
1 parent 9d6dead
commit 112f695
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/docs/apidocs/povm_toolbox.quantum_info.base.rst b/docs/apidocs/povm_toolbox.quantum_info.base.rst
@@ -11,3 +11,6 @@ Interfaces
    :members:
    :no-inherited-members:
    :no-special-members:
+
+.. autoclass:: LabelT
+   :members:
diff --git a/povm_toolbox/quantum_info/base/base_frame.py b/povm_toolbox/quantum_info/base/base_frame.py
@@ -8,7 +8,7 @@
 # copyright notice, and modified files need to carry a notice indicating
 # that they have been altered from the originals.
 
-"""TODO."""
+"""BaseFrame."""
 
 from __future__ import annotations
 
@@ -19,10 +19,12 @@
 import numpy as np
 from qiskit.quantum_info import Operator, SparsePauliOp
 
-# Each operator in the frame is identified by a label. ``LabelT`` is the type of
-# these labels. For instance, labels could be strings, integers, or it could be
-# tuples of integers among other possibilities.
 LabelT = TypeVar("LabelT")
+"""Each operator in the frame is identified by a label.
+
+This is the type of these labels. For instance, labels could be strings, integers, or it could be
+tuples of integers among other possibilities.
+"""
 
 
 class BaseFrame(ABC, Generic[LabelT]):