Review feedback

Qiskit · Oct 28, 2024 · d77a328 · d77a328
1 parent 91d12cf
commit d77a328
Show file tree

Hide file tree

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

diff --git a/docs/apidocs/qiskit_addon_obp.utils.operations.rst b/docs/apidocs/qiskit_addon_obp.utils.operations.rst
@@ -10,5 +10,6 @@ Operator utilities (:mod:`qiskit_addon_obp.utils.operations`)
 .. currentmodule:: qiskit_addon_obp.utils.operations
 
 .. autofunction:: apply_op_to
+.. autofunction:: apply_reset_to
 .. autofunction:: to_global_op
 .. autofunction:: reduce_op
diff --git a/docs/apidocs/qiskit_addon_obp.utils.simplify.rst b/docs/apidocs/qiskit_addon_obp.utils.simplify.rst
@@ -1,6 +1,6 @@
-=====================================================================
-Pauli operator simplfication (:mod:`qiskit_addon_obp.utils.simplify`)
-=====================================================================
+======================================================================
+Pauli operator simplification (:mod:`qiskit_addon_obp.utils.simplify`)
+======================================================================
 
 .. automodule:: qiskit_addon_obp.utils.simplify
    :no-members:

diff --git a/qiskit_addon_obp/utils/__init__.py b/qiskit_addon_obp/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.
 """Utility functionality for conducting operator backpropagation."""