Improve documentation of INFINITY (#569) (#570)

mergify[bot] · woodsp-ibm · web-flow · commit 7c8da76beb4d · 2023-11-20T22:46:59.000+09:00
(cherry picked from commit 1bccd2f) Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>
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
`@@ -14,3 +14,4 @@`
`14`	`14`
`15`	`15`
`16`	`16`	`INFINITY = 1.0e20 # pylint: disable=invalid-name`
	`17`	`+""" A constant for infinity. """`