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

Fix qiskit.circuit method header and broken cross-reference (backport #12394) #12424

Merged
merged 1 commit into from
May 17, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented May 17, 2024

Part of Qiskit/documentation#1275

The __array__ method has a wrong header in the API docs (as we can see in the following screenshot) because Sphinx is not able to set the correct id in the generated HTML for methods starting with double underscore. Instead, Sphinx truncates the name to array__.

Captura desde 2024-05-13 14-31-08

This PR changes the method to be instead builtins.__array__, and it also fixes a broken reference for Instruction.params. The cross-reference was broken due to the .. currentmodule:: None directive.

This is the result of Sphinx after this PR:

Captura desde 2024-05-13 14-27-06

The API docs will have the correct header because we only use the part after the last dot in the id.

The PR will need backport to stable/1.1


This is an automatic backport of pull request #12394 done by Mergify.

* Fix qiskit.circuit method header

* use object

* fix lint

* Correct method to be defined on `object`

---------

Co-authored-by: Jake Lishman <jake.lishman@ibm.com>
(cherry picked from commit 8b56995)
@mergify mergify bot requested a review from a team as a code owner May 17, 2024 01:37
@qiskit-bot
Copy link
Collaborator

Thank you for opening a new pull request.

Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient.

While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone.

One or more of the following people are relevant to this code:

  • @Qiskit/terra-core

@github-actions github-actions bot added documentation Something is not clear or an error documentation Changelog: None Do not include in changelog Intern PR PR submitted by IBM Quantum interns labels May 17, 2024
@coveralls
Copy link

Pull Request Test Coverage Report for Build 9121601643

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 19 unchanged lines in 3 files lost coverage.
  • Overall coverage decreased (-0.01%) to 89.607%

Files with Coverage Reduction New Missed Lines %
crates/qasm2/src/expr.rs 1 94.02%
crates/qasm2/src/lex.rs 6 92.37%
crates/qasm2/src/parse.rs 12 97.15%
Totals Coverage Status
Change from base Build 9117917188: -0.01%
Covered Lines: 62248
Relevant Lines: 69468

💛 - Coveralls

@jakelishman jakelishman added this pull request to the merge queue May 17, 2024
Merged via the queue into stable/1.1 with commit 80d5b8a May 17, 2024
18 checks passed
@mergify mergify bot deleted the mergify/bp/stable/1.1/pr-12394 branch May 17, 2024 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Changelog: None Do not include in changelog documentation Something is not clear or an error documentation Intern PR PR submitted by IBM Quantum interns
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants