Qiskit / qiskit

Qiskit is an open-source SDK for working with quantum computers at the level of extended quantum circuits, operators, and primitives.
https://www.ibm.com/quantum/qiskit
Apache License 2.0
5.28k stars 2.37k forks source link

Fix documentation for utils.optionals data values (backport #13098) #13101

Closed mergify[bot] closed 2 months ago

mergify[bot] commented 2 months ago

We're adding proper support to .. py:data:: to docs.quantum.ibm.com. However, we cannot easily handle .. py:data:: being inside a table - it would complicate both the code and visual design.

So, this PR removes the table and uses .. py:data:: like we use it everywhere else in Qiskit.


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

mergify[bot] commented 2 months ago

Cherry-pick of 254ba83dc637a22a91cee0a0cd1c453f89ca55da has failed:

On branch mergify/bp/stable/0.46/pr-13098
Your branch is up to date with 'origin/stable/0.46'.

You are currently cherry-picking commit 254ba83dc.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Unmerged paths:
  (use "git add <file>..." to mark resolution)
    both modified:   qiskit/utils/optionals.py

no changes added to commit (use "git add" and/or "git commit -a")

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

qiskit-bot commented 2 months ago

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:

coveralls commented 2 months ago

Pull Request Test Coverage Report for Build 10778463974

Details


Files with Coverage Reduction New Missed Lines %
qiskit/synthesis/two_qubit/two_qubit_decompose.py 2 96.72%
crates/qasm2/src/lex.rs 3 92.88%
<!-- Total: 5 -->
Totals Coverage Status
Change from base Build 10454948743: 0.02%
Covered Lines: 74535
Relevant Lines: 85459

💛 - Coveralls
Eric-Arellano commented 2 months ago

@jakelishman it's not very important to land this in Qiskit 0.46. For example, we're not adding it to 1.0 and 1.1. The docs still render fine, only they don't have the little anchor icon & objects.inv's links don't take you to the right part of the page.

Shall we close this given the non-trivial merge conflict?

eliarbel commented 2 months ago

@Eric-Arellano FWIW, please check out #13111. I've opened it against #13101. If it's ok let's apply the changes there and have it included in 0.46.3. Note that #13111 also includes a few minor fixes relevant for 1.3.