qiskit-community / qiskit-algorithms

A library of quantum algorithms for Qiskit.
https://qiskit-community.github.io/qiskit-algorithms/
Apache License 2.0
111 stars 54 forks source link

Fix bad indentation and missing hyphen on `vqd.py` #168

Closed arnaucasau closed 5 months ago

arnaucasau commented 5 months ago

This PR replicates the changes done in https://github.com/Qiskit/qiskit/pull/12162 (See for information) to qiskit/algorithms/eigensolvers/vqd.py to fix the docs of two attributes (optimizer and initial_point)

woodsp-ibm commented 5 months ago

Here copyright dates are checked so that the last modified date should now been 2024. Ie line 3 should look like this now (qiskit does not have this check in that repo)

# (C) Copyright IBM 2022, 2024.

coveralls commented 5 months ago

Pull Request Test Coverage Report for Build 8634230303

Details


Totals Coverage Status
Change from base Build 8093689332: 0.0%
Covered Lines: 6488
Relevant Lines: 7157

💛 - Coveralls
woodsp-ibm commented 5 months ago

Looking at the source I see lines 131 to 133 have a similar problem - not sure if you;d like to fix this too (I noticed when looking at the html built from here that the text, per the image, seemed weird)

            optimizer: A classical optimizer or a list of optimizers, one for every k-th eigenvalue.
            Can either be a Qiskit optimizer or a callable
                that takes an array as input and returns a Qiskit or SciPy optimization result.

image

arnaucasau commented 5 months ago

Oh, good catch! I didn't see it when I checked the file. I fixed it in the last commit, and I'll create another PR to do the same in the Qiskit/qiskit repo for stable/0.46. Thanks @woodsp-ibm :+1:

woodsp-ibm commented 5 months ago

Docs are now live with the fix https://qiskit-community.github.io/qiskit-algorithms/stubs/qiskit_algorithms.VQD.html