Add exceptions to API documentation#10522
Merged
Merged
Conversation
jakelishman
added
documentation
jakelishman
requested review from
a team,
ElePT,
ShellyGarion,
alexanderivrii,
eggerdj,
ikkoham,
jyu00,
woodsp-ibm and
wshanks
as code owners
Collaborator
|
One or more of the the following people are requested to review this:
|
jakelishman
force-pushed
the
document-exceptions
branch
from
ccbc524 to
bf42192
Compare
jakelishman
commented
Jul 28, 2023
| The (1 - alpha) confidence interval of the specified kind. | ||
|
|
||
| Raises: | ||
| AquaError: If 'mle' is not in self._ret.keys() (i.e. `run` was not called yet). |
Member
Author
There was a problem hiding this comment.
Obviously AquaError is wrong here, but as best as I could tell it was already out-of-date when it was merged in #5517, which seems to have involved some refactoring from old Aqua code that I couldn't be bothered to track down.
Member
There was a problem hiding this comment.
:) I happened to notice this too in qiskit-algorithms as that was prepared for release and it was taken care of there. I figured it had been here for years like this since it was brought over from Aqua and never noticed, and as it was not causing an issue and with algorithms set to be removed I.... (was the same "fix" we did there!)
Member
Author
There was a problem hiding this comment.
Ah, that's good that you'd spotted it on the new repo as well. I had a go at tracking down a point where the result object might have actually raised an error if mle wasn't present, but once it got into needing to find the base of refactored history from Aqua, I just gave up...
Collaborator
There was a problem hiding this comment.
This is from an old (very old) version of the code, where the algorithm classes were still stateful. Back then you had to run the algorithm to generate some info and then this enabled some post processing options.
The big change here is that `QiskitError` is added to the API documentation, which causes 400--500 previously failing Sphinx lookups (stemming from "Raises:" documentation) to now succeed. This commit also corrects several other places where exceptions were not being fully documented (and in several cases makes the imports more convenient as well), and corrects a couple of places with incorrect references to exceptions.
jakelishman
force-pushed
the
document-exceptions
branch
from
bf42192 to
a2fdddb
Compare
Pull Request Test Coverage Report for Build 5837187759
💛 - Coveralls |
Eric-Arellano
approved these changes
Aug 14, 2023
Contributor
Eric-Arellano
left a comment
Eric-Arellano
left a comment
There was a problem hiding this comment.
This looks great! Thanks Jake.
mtreinish
approved these changes
Aug 14, 2023
mergify Bot
pushed a commit
that referenced
this pull request
Aug 14, 2023
The big change here is that `QiskitError` is added to the API documentation, which causes 400--500 previously failing Sphinx lookups (stemming from "Raises:" documentation) to now succeed. This commit also corrects several other places where exceptions were not being fully documented (and in several cases makes the imports more convenient as well), and corrects a couple of places with incorrect references to exceptions. (cherry picked from commit 982807e) # Conflicts: # docs/apidocs/exceptions.rst # qiskit/dagcircuit/__init__.py # qiskit/passmanager/__init__.py # qiskit/transpiler/__init__.py
jaeunkim
pushed a commit
to jaeunkim/qiskit-terra
that referenced
this pull request
Aug 15, 2023
The big change here is that `QiskitError` is added to the API documentation, which causes 400--500 previously failing Sphinx lookups (stemming from "Raises:" documentation) to now succeed. This commit also corrects several other places where exceptions were not being fully documented (and in several cases makes the imports more convenient as well), and corrects a couple of places with incorrect references to exceptions.
github-merge-queue Bot
pushed a commit
that referenced
this pull request
Aug 15, 2023
* Add exceptions to API documentation (#10522) The big change here is that `QiskitError` is added to the API documentation, which causes 400--500 previously failing Sphinx lookups (stemming from "Raises:" documentation) to now succeed. This commit also corrects several other places where exceptions were not being fully documented (and in several cases makes the imports more convenient as well), and corrects a couple of places with incorrect references to exceptions. (cherry picked from commit 982807e) # Conflicts: # docs/apidocs/exceptions.rst # qiskit/dagcircuit/__init__.py # qiskit/passmanager/__init__.py # qiskit/transpiler/__init__.py * Fix merge conflicts This commit fixes several merge conflicts in the backport. They were mostly minor differences between main and the stable branch that needed to be corrected. --------- Co-authored-by: Jake Lishman <jake.lishman@ibm.com> Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The big change here is that
QiskitErroris added to the API documentation, which causes 400--500 previously failing Sphinx lookups (stemming from "Raises:" documentation) to now succeed. This commit also corrects several other places where exceptions were not being fully documented (and in several cases makes the imports more convenient as well), and corrects a couple of places with incorrect references to exceptions.Details and comments
This stemmed from an idle thought I had to turn on
nitpickyin the Sphinx configuration, which emits a warning if any cross-reference fails to resolve. That's probably a longer-term effort: including the ones fixed by this PR, there were 2791 warnings. It might cause some more nuisances with release notes and removals, but we'll have to see how that goes if we decide to actually turn the option on. The principle of making sure that most of our references resolve is good regardless, though.qiskit.algorithmsandqiskit.opfloware both deprecated but emit sizeable numbers of references, and the strategy here is probably just going to be to leave them be, since they're scheduled for removal from this repo anyway.