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 documentation for utils.optionals data values (backport #13098) #13101

Merged
merged 2 commits into from
Sep 12, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Sep 5, 2024

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](https://mergify.com).

(cherry picked from commit 254ba83)

# Conflicts:
#	qiskit/utils/optionals.py
@mergify mergify bot requested a review from woodsp-ibm as a code owner September 5, 2024 23:16
@mergify mergify bot added the conflicts used by mergify when there are conflicts in a port label Sep 5, 2024
@mergify mergify bot requested a review from a team as a code owner September 5, 2024 23:16
Copy link
Contributor Author

mergify bot commented Sep 5, 2024

Cherry-pick of 254ba83 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
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 labels Sep 5, 2024
@github-actions github-actions bot added this to the 0.46.3 milestone Sep 5, 2024
@coveralls
Copy link

coveralls commented Sep 5, 2024

Pull Request Test Coverage Report for Build 10778463974

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 5 unchanged lines in 2 files lost coverage.
  • Overall coverage increased (+0.02%) to 87.217%

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%
Totals Coverage Status
Change from base Build 10454948743: 0.02%
Covered Lines: 74535
Relevant Lines: 85459

💛 - Coveralls

@Eric-Arellano
Copy link
Collaborator

@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
Copy link
Contributor

eliarbel commented Sep 8, 2024

@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.

* Fix merge conflicts and a few minor issues

* Reorder IPYTHON and another typo fix

* Fix lint errors

* Update qiskit/utils/optionals.py

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

* Update qiskit/utils/optionals.py

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>

---------

Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>
Copy link
Contributor

@eliarbel eliarbel left a comment

Choose a reason for hiding this comment

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

LGTM

@ElePT ElePT added this pull request to the merge queue Sep 12, 2024
Merged via the queue into stable/0.46 with commit 0f93361 Sep 12, 2024
11 checks passed
@mergify mergify bot deleted the mergify/bp/stable/0.46/pr-13098 branch September 12, 2024 09:50
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 conflicts used by mergify when there are conflicts in a port documentation Something is not clear or an error documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants