From f299b32b0368408200d39c669c67c5e989e243eb Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Mon, 28 Oct 2024 12:38:12 -0400 Subject: [PATCH] Max review feedback --- docs/apidocs/index.rst | 6 +++--- qiskit_addon_mpf/__init__.py | 3 +++ 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/apidocs/index.rst b/docs/apidocs/index.rst index 3413c6a..7985618 100644 --- a/docs/apidocs/index.rst +++ b/docs/apidocs/index.rst @@ -1,6 +1,6 @@ -****************************** -qiskit-addon-mpf API reference -****************************** +********************************** +``qiskit-addon-mpf`` API reference +********************************** .. toctree:: :maxdepth: 1 diff --git a/qiskit_addon_mpf/__init__.py b/qiskit_addon_mpf/__init__.py index 4a4ab47..e2ee39e 100644 --- a/qiskit_addon_mpf/__init__.py +++ b/qiskit_addon_mpf/__init__.py @@ -10,4 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. +# Warning: this module is not documented and it does not have an RST file. +# If we ever publicly expose interfaces users can import from this module, +# we should set up its RST file. """Multi-product formulas."""