Qiskit / qiskit-terra / 5867522078

87%

main: 87%

push

github

Add exceptions to API documentation (backport #10522) (#10628)

* 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 982807e5b)

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

8 of 8 new or added lines in 8 files covered. (100.0%)

74085 of 84918 relevant lines covered (87.24%)

60949.84 hits per line