From 29fff032e5b6c404a0c2222cc6741e7dc21169f8 Mon Sep 17 00:00:00 2001 From: Lev Bishop <18673315+levbishop@users.noreply.github.com> Date: Wed, 1 Mar 2023 08:24:26 -0500 Subject: [PATCH] Fix docstring surrounding whitespace (Qiskit/qiskit-terra#9689) Co-authored-by: Jake Lishman --- qiskit_algorithms/amplitude_amplifiers/__init__.py | 2 +- qiskit_algorithms/eigen_solvers/__init__.py | 2 +- qiskit_algorithms/factorizers/__init__.py | 2 +- qiskit_algorithms/minimum_eigen_solvers/__init__.py | 2 +- qiskit_algorithms/minimum_eigen_solvers/qaoa.py | 2 +- qiskit_algorithms/minimum_eigensolvers/qaoa.py | 2 +- qiskit_algorithms/optimizers/nlopts/__init__.py | 2 +- qiskit_algorithms/optimizers/nlopts/direct_l.py | 2 +- qiskit_algorithms/optimizers/nlopts/direct_l_rand.py | 2 +- qiskit_algorithms/optimizers/nlopts/esch.py | 2 +- qiskit_algorithms/optimizers/nlopts/isres.py | 2 +- qiskit_algorithms/optimizers/nlopts/nloptimizer.py | 2 +- qiskit_algorithms/optimizers/tnc.py | 2 +- test/algorithms_test_case.py | 2 +- test/eigensolvers/test_numpy_eigensolver.py | 2 +- test/eigensolvers/test_vqd.py | 2 +- test/evolvers/trotterization/test_trotter_qrte.py | 2 +- test/minimum_eigensolvers/test_adapt_vqe.py | 2 +- test/minimum_eigensolvers/test_numpy_minimum_eigensolver.py | 2 +- test/optimizers/test_optimizer_aqgd.py | 2 +- test/optimizers/test_optimizer_nft.py | 2 +- test/optimizers/test_optimizers.py | 2 +- test/optimizers/test_optimizers_scikitquant.py | 2 +- test/test_backendv1.py | 2 +- test/test_backendv2.py | 2 +- test/test_entangler_map.py | 2 +- test/test_measure_error_mitigation.py | 2 +- test/test_numpy_eigen_solver.py | 2 +- test/test_numpy_minimum_eigen_solver.py | 2 +- test/test_qaoa.py | 2 +- test/test_shor.py | 2 +- test/test_skip_qobj_validation.py | 2 +- test/test_validation.py | 2 +- test/test_vqd.py | 2 +- test/test_vqe.py | 2 +- test/time_evolvers/test_trotter_qrte.py | 2 +- 36 files changed, 36 insertions(+), 36 deletions(-) diff --git a/qiskit_algorithms/amplitude_amplifiers/__init__.py b/qiskit_algorithms/amplitude_amplifiers/__init__.py index 058c31e8..bc45f181 100644 --- a/qiskit_algorithms/amplitude_amplifiers/__init__.py +++ b/qiskit_algorithms/amplitude_amplifiers/__init__.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Amplitude Amplifiers Package """ +"""Amplitude Amplifiers Package""" from .amplitude_amplifier import AmplitudeAmplifier, AmplitudeAmplifierResult from .amplification_problem import AmplificationProblem diff --git a/qiskit_algorithms/eigen_solvers/__init__.py b/qiskit_algorithms/eigen_solvers/__init__.py index c567ab4f..90cab015 100644 --- a/qiskit_algorithms/eigen_solvers/__init__.py +++ b/qiskit_algorithms/eigen_solvers/__init__.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Eigen Solvers Package """ +"""Eigen Solvers Package""" from .numpy_eigen_solver import NumPyEigensolver from .eigen_solver import Eigensolver, EigensolverResult diff --git a/qiskit_algorithms/factorizers/__init__.py b/qiskit_algorithms/factorizers/__init__.py index 76e3b59f..939614a3 100644 --- a/qiskit_algorithms/factorizers/__init__.py +++ b/qiskit_algorithms/factorizers/__init__.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Factorizers Package """ +"""Factorizers Package""" from .shor import Shor, ShorResult diff --git a/qiskit_algorithms/minimum_eigen_solvers/__init__.py b/qiskit_algorithms/minimum_eigen_solvers/__init__.py index 9a02b3fd..3d7d1802 100644 --- a/qiskit_algorithms/minimum_eigen_solvers/__init__.py +++ b/qiskit_algorithms/minimum_eigen_solvers/__init__.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Minimum Eigen Solvers Package """ +"""Minimum Eigen Solvers Package""" from .vqe import VQE, VQEResult from .qaoa import QAOA diff --git a/qiskit_algorithms/minimum_eigen_solvers/qaoa.py b/qiskit_algorithms/minimum_eigen_solvers/qaoa.py index be32ae36..2abdd5b4 100644 --- a/qiskit_algorithms/minimum_eigen_solvers/qaoa.py +++ b/qiskit_algorithms/minimum_eigen_solvers/qaoa.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" The Quantum Approximate Optimization Algorithm. """ +"""The Quantum Approximate Optimization Algorithm.""" from typing import List, Callable, Optional, Union import warnings diff --git a/qiskit_algorithms/minimum_eigensolvers/qaoa.py b/qiskit_algorithms/minimum_eigensolvers/qaoa.py index 11691470..bb1df403 100644 --- a/qiskit_algorithms/minimum_eigensolvers/qaoa.py +++ b/qiskit_algorithms/minimum_eigensolvers/qaoa.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -"""The quantum approximate optimization algorithm. """ +"""The quantum approximate optimization algorithm.""" from __future__ import annotations diff --git a/qiskit_algorithms/optimizers/nlopts/__init__.py b/qiskit_algorithms/optimizers/nlopts/__init__.py index d99e94ca..e3165bc0 100644 --- a/qiskit_algorithms/optimizers/nlopts/__init__.py +++ b/qiskit_algorithms/optimizers/nlopts/__init__.py @@ -10,4 +10,4 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" NLopt based global optimizers """ +"""NLopt based global optimizers""" diff --git a/qiskit_algorithms/optimizers/nlopts/direct_l.py b/qiskit_algorithms/optimizers/nlopts/direct_l.py index 1226defc..e7ed9be3 100644 --- a/qiskit_algorithms/optimizers/nlopts/direct_l.py +++ b/qiskit_algorithms/optimizers/nlopts/direct_l.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" DIviding RECTangles Locally-biased optimizer. """ +"""DIviding RECTangles Locally-biased optimizer.""" from .nloptimizer import NLoptOptimizer, NLoptOptimizerType diff --git a/qiskit_algorithms/optimizers/nlopts/direct_l_rand.py b/qiskit_algorithms/optimizers/nlopts/direct_l_rand.py index 352e3159..15172ef0 100644 --- a/qiskit_algorithms/optimizers/nlopts/direct_l_rand.py +++ b/qiskit_algorithms/optimizers/nlopts/direct_l_rand.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -"""DIviding RECTangles Locally-biased Randomized optimizer. """ +"""DIviding RECTangles Locally-biased Randomized optimizer.""" from .nloptimizer import NLoptOptimizer, NLoptOptimizerType diff --git a/qiskit_algorithms/optimizers/nlopts/esch.py b/qiskit_algorithms/optimizers/nlopts/esch.py index 4700fc53..7e754f94 100644 --- a/qiskit_algorithms/optimizers/nlopts/esch.py +++ b/qiskit_algorithms/optimizers/nlopts/esch.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" ESCH evolutionary optimizer. """ +"""ESCH evolutionary optimizer.""" from .nloptimizer import NLoptOptimizer, NLoptOptimizerType diff --git a/qiskit_algorithms/optimizers/nlopts/isres.py b/qiskit_algorithms/optimizers/nlopts/isres.py index 9cbcbaca..1c37a940 100644 --- a/qiskit_algorithms/optimizers/nlopts/isres.py +++ b/qiskit_algorithms/optimizers/nlopts/isres.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Improved Stochastic Ranking Evolution Strategy optimizer. """ +"""Improved Stochastic Ranking Evolution Strategy optimizer.""" from .nloptimizer import NLoptOptimizer, NLoptOptimizerType diff --git a/qiskit_algorithms/optimizers/nlopts/nloptimizer.py b/qiskit_algorithms/optimizers/nlopts/nloptimizer.py index 8949ea1e..7bc20c97 100644 --- a/qiskit_algorithms/optimizers/nlopts/nloptimizer.py +++ b/qiskit_algorithms/optimizers/nlopts/nloptimizer.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Minimize using objective function """ +"""Minimize using objective function""" from typing import List, Optional, Tuple, Callable from enum import Enum diff --git a/qiskit_algorithms/optimizers/tnc.py b/qiskit_algorithms/optimizers/tnc.py index 57448bbb..11bca263 100644 --- a/qiskit_algorithms/optimizers/tnc.py +++ b/qiskit_algorithms/optimizers/tnc.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -"""Truncated Newton (TNC) optimizer. """ +"""Truncated Newton (TNC) optimizer.""" from typing import Optional diff --git a/test/algorithms_test_case.py b/test/algorithms_test_case.py index 2a54c84e..8fc9effd 100644 --- a/test/algorithms_test_case.py +++ b/test/algorithms_test_case.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Algorithms Test Case """ +"""Algorithms Test Case""" from qiskit.test import QiskitTestCase diff --git a/test/eigensolvers/test_numpy_eigensolver.py b/test/eigensolvers/test_numpy_eigensolver.py index 870b145a..13f2f9a6 100644 --- a/test/eigensolvers/test_numpy_eigensolver.py +++ b/test/eigensolvers/test_numpy_eigensolver.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Test NumPyEigensolver """ +"""Test NumPyEigensolver""" import unittest from test.python.algorithms import QiskitAlgorithmsTestCase diff --git a/test/eigensolvers/test_vqd.py b/test/eigensolvers/test_vqd.py index bd01311d..ffc8441f 100644 --- a/test/eigensolvers/test_vqd.py +++ b/test/eigensolvers/test_vqd.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Test VQD """ +"""Test VQD""" import unittest from test.python.algorithms import QiskitAlgorithmsTestCase diff --git a/test/evolvers/trotterization/test_trotter_qrte.py b/test/evolvers/trotterization/test_trotter_qrte.py index fe53f929..47e4940b 100644 --- a/test/evolvers/trotterization/test_trotter_qrte.py +++ b/test/evolvers/trotterization/test_trotter_qrte.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Test TrotterQRTE. """ +"""Test TrotterQRTE.""" import unittest diff --git a/test/minimum_eigensolvers/test_adapt_vqe.py b/test/minimum_eigensolvers/test_adapt_vqe.py index 16589a12..c4764eef 100644 --- a/test/minimum_eigensolvers/test_adapt_vqe.py +++ b/test/minimum_eigensolvers/test_adapt_vqe.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Test of the AdaptVQE minimum eigensolver """ +"""Test of the AdaptVQE minimum eigensolver""" import unittest from test.python.algorithms import QiskitAlgorithmsTestCase diff --git a/test/minimum_eigensolvers/test_numpy_minimum_eigensolver.py b/test/minimum_eigensolvers/test_numpy_minimum_eigensolver.py index d0da63c5..f5724f77 100644 --- a/test/minimum_eigensolvers/test_numpy_minimum_eigensolver.py +++ b/test/minimum_eigensolvers/test_numpy_minimum_eigensolver.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Test NumPy minimum eigensolver """ +"""Test NumPy minimum eigensolver""" import unittest from test.python.algorithms import QiskitAlgorithmsTestCase diff --git a/test/optimizers/test_optimizer_aqgd.py b/test/optimizers/test_optimizer_aqgd.py index 7beee3eb..d4923b7c 100644 --- a/test/optimizers/test_optimizer_aqgd.py +++ b/test/optimizers/test_optimizer_aqgd.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Test of AQGD optimizer """ +"""Test of AQGD optimizer""" import unittest from test.python.algorithms import QiskitAlgorithmsTestCase diff --git a/test/optimizers/test_optimizer_nft.py b/test/optimizers/test_optimizer_nft.py index d920e025..b3f81318 100644 --- a/test/optimizers/test_optimizer_nft.py +++ b/test/optimizers/test_optimizer_nft.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Test of NFT optimizer """ +"""Test of NFT optimizer""" import unittest from test.python.algorithms import QiskitAlgorithmsTestCase diff --git a/test/optimizers/test_optimizers.py b/test/optimizers/test_optimizers.py index 5ce8e87c..c8b65db0 100644 --- a/test/optimizers/test_optimizers.py +++ b/test/optimizers/test_optimizers.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Test Optimizers """ +"""Test Optimizers""" import unittest from test.python.algorithms import QiskitAlgorithmsTestCase diff --git a/test/optimizers/test_optimizers_scikitquant.py b/test/optimizers/test_optimizers_scikitquant.py index 70716c4e..503451de 100644 --- a/test/optimizers/test_optimizers_scikitquant.py +++ b/test/optimizers/test_optimizers_scikitquant.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Test of scikit-quant optimizers. """ +"""Test of scikit-quant optimizers.""" import unittest from test.python.algorithms import QiskitAlgorithmsTestCase diff --git a/test/test_backendv1.py b/test/test_backendv1.py index 75d0615d..67514cbd 100644 --- a/test/test_backendv1.py +++ b/test/test_backendv1.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Test Providers that support BackendV1 interface """ +"""Test Providers that support BackendV1 interface""" import unittest import warnings diff --git a/test/test_backendv2.py b/test/test_backendv2.py index b22608f7..3945c82f 100644 --- a/test/test_backendv2.py +++ b/test/test_backendv2.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Test Providers that support BackendV2 interface """ +"""Test Providers that support BackendV2 interface""" import unittest import warnings diff --git a/test/test_entangler_map.py b/test/test_entangler_map.py index d6469404..56dd5100 100644 --- a/test/test_entangler_map.py +++ b/test/test_entangler_map.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Test Entangler Map """ +"""Test Entangler Map""" import unittest diff --git a/test/test_measure_error_mitigation.py b/test/test_measure_error_mitigation.py index b41129a6..b53b6fd7 100644 --- a/test/test_measure_error_mitigation.py +++ b/test/test_measure_error_mitigation.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Test Measurement Error Mitigation """ +"""Test Measurement Error Mitigation""" import unittest diff --git a/test/test_numpy_eigen_solver.py b/test/test_numpy_eigen_solver.py index d2a918a8..d26b6e20 100644 --- a/test/test_numpy_eigen_solver.py +++ b/test/test_numpy_eigen_solver.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Test NumPy Eigen solver """ +"""Test NumPy Eigen solver""" import unittest from test.python.algorithms import QiskitAlgorithmsTestCase diff --git a/test/test_numpy_minimum_eigen_solver.py b/test/test_numpy_minimum_eigen_solver.py index 6523e3d1..160e2796 100644 --- a/test/test_numpy_minimum_eigen_solver.py +++ b/test/test_numpy_minimum_eigen_solver.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Test NumPy Minimum Eigensolver """ +"""Test NumPy Minimum Eigensolver""" import unittest from test.python.algorithms import QiskitAlgorithmsTestCase diff --git a/test/test_qaoa.py b/test/test_qaoa.py index 2998c1f1..87e5a605 100644 --- a/test/test_qaoa.py +++ b/test/test_qaoa.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Test QAOA """ +"""Test QAOA""" import unittest from test.python.algorithms import QiskitAlgorithmsTestCase diff --git a/test/test_shor.py b/test/test_shor.py index 3b2ce675..742f7eb1 100644 --- a/test/test_shor.py +++ b/test/test_shor.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Test Shor """ +"""Test Shor""" import unittest import warnings diff --git a/test/test_skip_qobj_validation.py b/test/test_skip_qobj_validation.py index dc7b7a0e..f3ef8827 100644 --- a/test/test_skip_qobj_validation.py +++ b/test/test_skip_qobj_validation.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Test Skip Qobj Validation """ +"""Test Skip Qobj Validation""" import unittest diff --git a/test/test_validation.py b/test/test_validation.py index 5a8e1845..b9a7c175 100644 --- a/test/test_validation.py +++ b/test/test_validation.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Test Validation """ +"""Test Validation""" import unittest diff --git a/test/test_vqd.py b/test/test_vqd.py index 72d82568..2fb2a573 100644 --- a/test/test_vqd.py +++ b/test/test_vqd.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Test VQD """ +"""Test VQD""" import unittest from test.python.algorithms import QiskitAlgorithmsTestCase diff --git a/test/test_vqe.py b/test/test_vqe.py index ae1d5782..3e2d4f24 100644 --- a/test/test_vqe.py +++ b/test/test_vqe.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Test VQE """ +"""Test VQE""" import logging import unittest diff --git a/test/time_evolvers/test_trotter_qrte.py b/test/time_evolvers/test_trotter_qrte.py index 6c342bb5..38e0bb93 100644 --- a/test/time_evolvers/test_trotter_qrte.py +++ b/test/time_evolvers/test_trotter_qrte.py @@ -10,7 +10,7 @@ # copyright notice, and modified files need to carry a notice indicating # that they have been altered from the originals. -""" Test TrotterQRTE. """ +"""Test TrotterQRTE.""" import unittest from test.python.algorithms import QiskitAlgorithmsTestCase