Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve ZZFeatureMap API docs #12431

Open
Eric-Arellano opened this issue May 17, 2024 · 1 comment
Open

Improve ZZFeatureMap API docs #12431

Eric-Arellano opened this issue May 17, 2024 · 1 comment
Labels
documentation Something is not clear or an error documentation

Comments

@Eric-Arellano
Copy link
Collaborator

Feedback from Paul Nation:

This page is very out of date: https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.library.ZZFeatureMap. and some of the code is not even valid anymore. e.g `
ZZFeatureMap(3) + EfficientSU2(3)
raises TypeError: unsupported operand type(s) for +: 'ZZFeatureMap' and 'EfficientSU2'

Also the data, entanglement_blocks , num_parameters, and parameters properties have no docstring or type hints:

Screenshot 2024-05-17 at 10 56 54 AM
@Eric-Arellano Eric-Arellano added the documentation Something is not clear or an error documentation label May 17, 2024
@nonhermitian
Copy link
Contributor

It looks like the docs have not been updated in 4 years, and the doc strings are not evaluated to find broken code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something is not clear or an error documentation
Projects
None yet
Development

No branches or pull requests

2 participants