Max review feedback

Qiskit · Oct 28, 2024 · aad63de · aad63de
1 parent 1d0619d
commit aad63de
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/docs/apidocs/index.rst b/docs/apidocs/index.rst
@@ -1,6 +1,6 @@
-********************************
-qiskit-addon-utils API reference
-********************************
+************************************
+``qiskit-addon-utils`` API reference
+************************************
 
 This package contains functionality which is meant to supplement workflows involving one or more Qiskit addons. For example, this package contains functions for creating Hamiltonians, generating Trotter time evolution circuits, and slicing and combining quantum circuits in time-wise partitions.
 

diff --git a/qiskit_addon_utils/__init__.py b/qiskit_addon_utils/__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.
 """Utilities for Qiskit addons."""
diff --git a/qiskit_addon_utils/slicing/transpiler/__init__.py b/qiskit_addon_utils/slicing/transpiler/__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.
 """A submodule with transpiler utilities for slicing."""