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

Remove the duplicated docs for a BackendV1 classmethod (backport #12443) #12444

Merged
merged 1 commit into from
May 20, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented May 20, 2024

The BackendV1 page has a duplicated entry for the _default_options() method as we can see in this screenshot highlight it with two red arrows.

323689526-2d78f5f6-ab3f-402c-a53d-d684078c208f

This PR removes the duplicated autoclass directive for _default_options() and the line of documentation explaining that subclasses need to implement it, as it is also explained in line 66.

Subclasses of this should override the public method :meth:`run` and the internal
:meth:`_default_options`:
.. automethod:: _default_options

With this removal, the docs will match the documentation of BackendV2 where we use the same explanation once:

Subclasses of this should override the public method :meth:`run` and the internal
:meth:`_default_options`:
.. automethod:: _default_options

The change will need backport to stable/1.1, stable/1.0, and stable/0.46


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

@mergify mergify bot requested review from jyu00 and a team as code owners May 20, 2024 14:41
@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 Community PR PRs from contributors that are not 'members' of the Qiskit repo labels May 20, 2024
@github-actions github-actions bot added this to the 1.1.1 milestone May 20, 2024
@jakelishman jakelishman enabled auto-merge May 20, 2024 14:46
@coveralls
Copy link

Pull Request Test Coverage Report for Build 9160468078

Details

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

Files with Coverage Reduction New Missed Lines %
qiskit/transpiler/passes/synthesis/unitary_synthesis.py 2 88.2%
crates/qasm2/src/lex.rs 6 91.86%
crates/qasm2/src/parse.rs 6 97.15%
Totals Coverage Status
Change from base Build 9133287908: -0.02%
Covered Lines: 62247
Relevant Lines: 69468

💛 - Coveralls

@jakelishman jakelishman added this pull request to the merge queue May 20, 2024
Merged via the queue into stable/1.1 with commit 3d90917 May 20, 2024
18 checks passed
@mergify mergify bot deleted the mergify/bp/stable/1.1/pr-12443 branch May 20, 2024 16:20
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 Community PR PRs from contributors that are not 'members' of the Qiskit repo documentation Something is not clear or an error documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants