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

Improve documentation of INFINITY #569

Merged
merged 1 commit into from
Nov 20, 2023

Conversation

woodsp-ibm
Copy link
Member

Summary

Fixes #10

It now comes out as

image

with the linked page

image

It did try with autodata which brings what is in the separate page inline there on the main page. But then it has that yellow stripe across the page which changed things more. I know we have brought all methods onto the same page so maybe that is reasonable to do. But since it changed things more than simply fixing the text of what was there I left it with this more minimal change.

Either as it stands or with autodata it needs the fully qualified path to bring in the comment for the constant - otherwise you still get that Convert a string or number to a floating point number, if possible. which is what the docs currently show,

Details and comments

I labelled it backport since we publish docs off stable and maybe we want to update/re-publish the docs with this fix.

@woodsp-ibm woodsp-ibm added stable backport potential The bug might be minimal and/or import enough to be port to stable type: documentation Issues related to documentation labels Nov 16, 2023
@coveralls
Copy link

Pull Request Test Coverage Report for Build 6893802419

  • 1 of 1 (100.0%) changed or added relevant line in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.001%) to 93.029%

Totals Coverage Status
Change from base Build 6868641971: 0.001%
Covered Lines: 4511
Relevant Lines: 4849

💛 - Coveralls

@mergify mergify bot merged commit 1bccd2f into qiskit-community:main Nov 20, 2023
15 checks passed
mergify bot pushed a commit that referenced this pull request Nov 20, 2023
@t-imamichi
Copy link
Collaborator

Thank you for fixing the longstanding issue!

t-imamichi pushed a commit that referenced this pull request Nov 20, 2023
(cherry picked from commit 1bccd2f)

Co-authored-by: Steve Wood <[email protected]>
@woodsp-ibm woodsp-ibm deleted the fix_infinity branch November 20, 2023 15:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge stable backport potential The bug might be minimal and/or import enough to be port to stable type: documentation Issues related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation of qiskit.optimization.INFINITY looks strange
3 participants