Improve documentation of INFINITY (#569)

qiskit-community · Nov 20, 2023 · 1bccd2f · 1bccd2f
1 parent 9c95fa8
commit 1bccd2f
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 3 deletions.
diff --git a/qiskit_optimization/__init__.py b/qiskit_optimization/__init__.py
@@ -68,9 +68,7 @@
    :toctree: ../stubs/
    :nosignatures:
 
-    INFINITY
-
-A constant for infinity.
+    ~qiskit_optimization.infinity.INFINITY
 
 Submodules
 ==========

diff --git a/qiskit_optimization/infinity.py b/qiskit_optimization/infinity.py
@@ -14,3 +14,4 @@
 
 
 INFINITY = 1.0e20  # pylint: disable=invalid-name
+""" A constant for infinity. """
Original file line number	Diff line number	Diff line change
Expand Up		@@ -14,3 +14,4 @@


		INFINITY = 1.0e20 # pylint: disable=invalid-name
		""" A constant for infinity. """