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 #12443

Merged
merged 1 commit into from
May 20, 2024

Conversation

arnaucasau
Copy link
Contributor

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

@arnaucasau arnaucasau requested review from jyu00 and a team as code owners May 20, 2024 12:46
@qiskit-bot qiskit-bot added the Community PR PRs from contributors that are not 'members' of the Qiskit repo label May 20, 2024
@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

@coveralls
Copy link

Pull Request Test Coverage Report for Build 9158916524

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 3 unchanged lines in 1 file lost coverage.
  • Overall coverage increased (+0.02%) to 89.622%

Files with Coverage Reduction New Missed Lines %
crates/qasm2/src/lex.rs 3 93.38%
Totals Coverage Status
Change from base Build 9134495129: 0.02%
Covered Lines: 62309
Relevant Lines: 69524

💛 - Coveralls

Copy link
Member

@jakelishman jakelishman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems right to me thanks, given that it's specified already in the class docs.

@jakelishman jakelishman added documentation Something is not clear or an error documentation stable backport potential The bug might be minimal and/or import enough to be port to stable Changelog: None Do not include in changelog labels May 20, 2024
@jakelishman jakelishman added this to the 1.1.1 milestone May 20, 2024
@jakelishman jakelishman added this pull request to the merge queue May 20, 2024
Merged via the queue into Qiskit:main with commit 16acb80 May 20, 2024
15 checks passed
mergify bot pushed a commit that referenced this pull request May 20, 2024
github-merge-queue bot pushed a commit that referenced this pull request May 20, 2024
(cherry picked from commit 16acb80)

Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com>
ElePT pushed a commit to ElePT/qiskit that referenced this pull request May 31, 2024
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 stable backport potential The bug might be minimal and/or import enough to be port to stable
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants