Skip to content

Commit

Permalink
Fix docstring surrounding whitespace (Qiskit/qiskit#9689)
Browse files Browse the repository at this point in the history
Co-authored-by: Jake Lishman <jake.lishman@ibm.com>
  • Loading branch information
levbishop and jakelishman committed Mar 1, 2023
1 parent 6ffff0c commit 29fff03
Show file tree
Hide file tree
Showing 36 changed files with 36 additions and 36 deletions.
2 changes: 1 addition & 1 deletion qiskit_algorithms/amplitude_amplifiers/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion qiskit_algorithms/eigen_solvers/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion qiskit_algorithms/factorizers/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion qiskit_algorithms/minimum_eigen_solvers/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion qiskit_algorithms/minimum_eigen_solvers/qaoa.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion qiskit_algorithms/minimum_eigensolvers/qaoa.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion qiskit_algorithms/optimizers/nlopts/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"""
2 changes: 1 addition & 1 deletion qiskit_algorithms/optimizers/nlopts/direct_l.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion qiskit_algorithms/optimizers/nlopts/direct_l_rand.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion qiskit_algorithms/optimizers/nlopts/esch.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion qiskit_algorithms/optimizers/nlopts/isres.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion qiskit_algorithms/optimizers/nlopts/nloptimizer.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion qiskit_algorithms/optimizers/tnc.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion test/algorithms_test_case.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion test/eigensolvers/test_numpy_eigensolver.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion test/eigensolvers/test_vqd.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion test/evolvers/trotterization/test_trotter_qrte.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion test/minimum_eigensolvers/test_adapt_vqe.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion test/optimizers/test_optimizer_aqgd.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion test/optimizers/test_optimizer_nft.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion test/optimizers/test_optimizers.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion test/optimizers/test_optimizers_scikitquant.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion test/test_backendv1.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion test/test_backendv2.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion test/test_entangler_map.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion test/test_measure_error_mitigation.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion test/test_numpy_eigen_solver.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion test/test_numpy_minimum_eigen_solver.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion test/test_qaoa.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion test/test_shor.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion test/test_skip_qobj_validation.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion test/test_validation.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion test/test_vqd.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion test/test_vqe.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion test/time_evolvers/test_trotter_qrte.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 29fff03

Please sign in to comment.