From 4439e7b8bb39b43daac5655e0d2e62cbac9dc69c Mon Sep 17 00:00:00 2001 From: Samantha Barron Date: Fri, 13 Dec 2024 16:14:07 +0000 Subject: [PATCH 1/3] add containers docs --- qiskit/primitives/__init__.py | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/qiskit/primitives/__init__.py b/qiskit/primitives/__init__.py index c4fb9855115f..57be582a45b0 100644 --- a/qiskit/primitives/__init__.py +++ b/qiskit/primitives/__init__.py @@ -454,6 +454,24 @@ BackendSampler SamplerResult + +Containers +---------- + +.. autosummary:: + :toctree: ../stubs/ + + BitArray + DataBin + PrimitiveResult + PubResult + EstimatorPubLike + SamplerPubLike + SamplerPubResult + BindingsArrayLike + ObservableLike + ObservablesArrayLike + """ from .backend_estimator import BackendEstimator From e51f4a2fccb771ce74450f2af51a36ed30f492cd Mon Sep 17 00:00:00 2001 From: Samantha Barron Date: Fri, 13 Dec 2024 18:44:59 +0000 Subject: [PATCH 2/3] reno --- releasenotes/notes/add-containers-docs-03d8b8aa0ca6b4bf.yaml | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 releasenotes/notes/add-containers-docs-03d8b8aa0ca6b4bf.yaml diff --git a/releasenotes/notes/add-containers-docs-03d8b8aa0ca6b4bf.yaml b/releasenotes/notes/add-containers-docs-03d8b8aa0ca6b4bf.yaml new file mode 100644 index 000000000000..dd400949ef78 --- /dev/null +++ b/releasenotes/notes/add-containers-docs-03d8b8aa0ca6b4bf.yaml @@ -0,0 +1,4 @@ +--- +other: + - | + Added documentation for `BitArray`, `DataBin`, `PrimitiveResult`, `PubResult`, `EstimatorPubLike`, `SamplerPubLike`, `SamplerPubResult`, `BindingsArrayLike`, `ObservableLike`, and `ObservablesArrayLike` \ No newline at end of file From b5adfa0c2f9705fc73a00d5da4051a7a0b7342c8 Mon Sep 17 00:00:00 2001 From: Samantha Barron Date: Mon, 16 Dec 2024 11:46:07 -0500 Subject: [PATCH 3/3] Update releasenotes/notes/add-containers-docs-03d8b8aa0ca6b4bf.yaml Co-authored-by: Ian Hincks --- releasenotes/notes/add-containers-docs-03d8b8aa0ca6b4bf.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/releasenotes/notes/add-containers-docs-03d8b8aa0ca6b4bf.yaml b/releasenotes/notes/add-containers-docs-03d8b8aa0ca6b4bf.yaml index dd400949ef78..0f5042c2568e 100644 --- a/releasenotes/notes/add-containers-docs-03d8b8aa0ca6b4bf.yaml +++ b/releasenotes/notes/add-containers-docs-03d8b8aa0ca6b4bf.yaml @@ -1,4 +1,4 @@ --- other: - | - Added documentation for `BitArray`, `DataBin`, `PrimitiveResult`, `PubResult`, `EstimatorPubLike`, `SamplerPubLike`, `SamplerPubResult`, `BindingsArrayLike`, `ObservableLike`, and `ObservablesArrayLike` \ No newline at end of file + Added documentation for `BitArray`, `DataBin`, `PrimitiveResult`, `PubResult`, `EstimatorPubLike`, `SamplerPubLike`, `SamplerPubResult`, `BindingsArrayLike`, `ObservableLike`, and `ObservablesArrayLike`. \ No newline at end of file