diff options
| author | John Snow <jsnow@redhat.com> | 2021-04-21 15:22:26 -0400 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2021-04-30 12:59:54 +0200 |
| commit | 46f49468c690ff015a5b5346a279845f5e55369e (patch) | |
| tree | 6f43a7ef3448b81544108649d26fbbf77c34afb7 /docs/sphinx | |
| parent | e81718c698a9f1a1d98edd605f508dadbffe0d4d (diff) | |
qapi/error: Repurpose QAPIError as an abstract base exception class
Rename QAPIError to QAPISourceError, and then create a new QAPIError
class that serves as the basis for all of our other custom exceptions,
without specifying any class properties.
This leaves QAPIError as a package-wide error class that's suitable for
any current or future errors.
(Right now, we don't have any errors that DON'T also want to specify a
Source location, but this MAY change. In these cases, a common abstract
ancestor would be desired.)
Add docstrings to explain the intended function of each error class.
Signed-off-by: John Snow <jsnow@redhat.com>
Message-Id: <20210421192233.3542904-2-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'docs/sphinx')
| -rw-r--r-- | docs/sphinx/qapidoc.py | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py index b7a2d39c10..87c67ab23f 100644 --- a/docs/sphinx/qapidoc.py +++ b/docs/sphinx/qapidoc.py @@ -34,7 +34,8 @@ from sphinx.errors import ExtensionError from sphinx.util.nodes import nested_parse_with_titles import sphinx from qapi.gen import QAPISchemaVisitor -from qapi.schema import QAPIError, QAPISemError, QAPISchema +from qapi.error import QAPIError, QAPISemError +from qapi.schema import QAPISchema # Sphinx up to 1.6 uses AutodocReporter; 1.7 and later |