Define a ClientError to fix Sphinx build errors (#352)

Co-authored-by: Isaac Good <[email protected]>
jd · Apr 27, 2022 · a858965 · a858965
1 parent ff48431
commit a858965
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -205,6 +205,9 @@ exceptions, as in the cases here.
 
 .. testcode::
 
+    class ClientError(Exception):
+        """Some type of client error."""
+
     @retry(retry=retry_if_exception_type(IOError))
     def might_io_error():
         print("Retry forever with no wait if an IOError occurs, raise any other errors")

diff --git a/releasenotes/notes/sphinx_define_error-642c9cd5c165d39a.yaml b/releasenotes/notes/sphinx_define_error-642c9cd5c165d39a.yaml
@@ -0,0 +1,2 @@
+---
+fixes: Sphinx build error where Sphinx complains about an undefined class.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		---
		fixes: Sphinx build error where Sphinx complains about an undefined class.