Error importing VQE - Githubissues

cgustin99 commented 1 year ago

Environment

Qiskit Terra version: 0.24.1
Python version: 3.10
Operating system: IBM Quantum Lab via MacOS

What is happening?

When I import VQE, I get a deprecation warning error message.

How can we reproduce the issue?

from qiskit.algorithms.minimum_eigensolvers import VQE

What should happen?

The error message I get is:

Traceback (most recent call last):
  Cell In[14], line 1
    from qiskit.algorithms.minimum_eigensolvers import VQE
  File /opt/conda/lib/python3.10/site-packages/qiskit/algorithms/__init__.py:238
    from .phase_estimators import (
  File /opt/conda/lib/python3.10/site-packages/qiskit/algorithms/phase_estimators/__init__.py:16
    from .phase_estimation import PhaseEstimation
  File /opt/conda/lib/python3.10/site-packages/qiskit/algorithms/phase_estimators/phase_estimation.py:27
    from .phase_estimation_result import PhaseEstimationResult, _sort_phases
  File /opt/conda/lib/python3.10/site-packages/qiskit/algorithms/phase_estimators/phase_estimation_result.py:23
    class PhaseEstimationResult(PhaseEstimatorResult):
  File /opt/conda/lib/python3.10/site-packages/qiskit/algorithms/phase_estimators/phase_estimation_result.py:76 in PhaseEstimationResult
    def most_likely_phase(self) -> float:
  File /opt/conda/lib/python3.10/site-packages/qiskit/utils/deprecation.py:306 in decorator
  File /opt/conda/lib/python3.10/site-packages/qiskit/utils/deprecation.py:426 in add_deprecation_to_docstring
ValueError: Deprecation messages cannot contain new lines (`\n`), but the deprecation for PhaseEstimationResult.most_likely_phase had them. Usually this happens when using `"""` multiline strings; instead, use string concatenation.

This is a simplification to facilitate deprecation messages being added to the documentation. If you have a compelling reason to need new lines, feel free to improve this function or open a request at https://github.com/Qiskit/qiskit-terra/issues.