Max review feedback

Qiskit · Oct 28, 2024 · 6da9712 · 6da9712
1 parent 013376d
commit 6da9712
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/docs/apidocs/index.rst b/docs/apidocs/index.rst
@@ -1,6 +1,6 @@
-******************************
-qiskit-addon-sqd API reference
-******************************
+**********************************
+``qiskit-addon-sqd`` API reference
+**********************************
 
 .. toctree::
    :maxdepth: 1

diff --git a/qiskit_addon_sqd/__init__.py b/qiskit_addon_sqd/__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.
 """Primary SQD functionality."""