Documented CompletionError class

1 files changed, 4 insertions, 4 deletions

diff --git a/cmd2/utils.py b/cmd2/utils.py
index 3fd9e3ac..5a4fdbf7 100644
--- a/cmd2/utils.py
+++ b/cmd2/utils.py
@@ -74,12 +74,12 @@ def str_to_bool(val: str) -> bool:
 
 class CompletionError(Exception):
     """
-    Raised during tab completion operations to report any sort of error you want printed by the ArgparseCompleter
-    This can also be used just to display a message, even if it's not an error. ArgparseCompleter raises
-    CompletionErrors to display tab completion hints and sets apply_style to False so hints aren't colored
-    like error text.
+    Raised during tab completion operations to report any sort of error you want printed. This can also be used
+    just to display a message, even if it's not an error. For instance, ArgparseCompleter raises CompletionErrors
+    to display tab completion hints and sets apply_style to False so hints aren't colored like error text.
 
     Example use cases
+
     - Reading a database to retrieve a tab completion data set failed
     - A previous command line argument that determines the data set being completed is invalid
     - Tab completion hints