From 7c8da76beb4dbcaa5ad601ea4fd94b498134f580 Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Mon, 20 Nov 2023 22:46:59 +0900 Subject: [PATCH] Improve documentation of INFINITY (#569) (#570) (cherry picked from commit 1bccd2fc5fa151e2c7e4f1827c16fce4e6e57a1c) Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com> --- qiskit_optimization/__init__.py | 4 +--- qiskit_optimization/infinity.py | 1 + 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/qiskit_optimization/__init__.py b/qiskit_optimization/__init__.py index f6ae8e1c7..b76a42f4f 100644 --- 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 index 16f3b3e27..95b6e8aad 100644 --- 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. """