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

Attributes section header is going in the incorrect place #2419

Open
Eric-Arellano opened this issue Dec 2, 2024 · 0 comments
Open

Attributes section header is going in the incorrect place #2419

Eric-Arellano opened this issue Dec 2, 2024 · 0 comments

Comments

@Eric-Arellano
Copy link
Collaborator

For some of the Circuit Library functions, the parameters for the class constructor appear underneath the header "Attributes". This happens in both Sphinx and our repository, such as the 1.3 docs for qiskit.circuit.library.PhaseGate.

Image

Note that these parameters don't have any docstring associated with them. This problem was detected in #2418, which adds parameters with no docstring. Maybe this happens in that specific edge case where there aren't documented parameters?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

1 participant