Skip to content

Commit 65d4518

Browse files
committed
Additional docstrings for exceptions
1 parent 07e5018 commit 65d4518

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

twitchio/ext/commands/exceptions.py

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,17 +110,22 @@ def __init__(self, msg: str | None = None, *, guard: Any | None = None) -> None:
110110
super().__init__(msg or "")
111111

112112

113-
class ConversionError(ArgumentError): ...
113+
class ConversionError(ArgumentError):
114+
"""Base exception for conversion errors."""
114115

115116

116117
class BadArgument(ConversionError):
118+
"""Exception raised when a parsing or conversion failure is encountered on an argument to pass into a command."""
119+
117120
def __init__(self, msg: str, *, name: str | None = None, value: str | None) -> None:
118121
self.name: str | None = name
119122
self.value: str | None = value
120123
super().__init__(msg)
121124

122125

123126
class MissingRequiredArgument(ArgumentError):
127+
"""Exception raised when parsing a command and a parameter that is required is not encountered."""
128+
124129
def __init__(self, param: inspect.Parameter) -> None:
125130
self.param: inspect.Parameter = param
126131
super().__init__(f'"{param.name}" is a required argument which is missing.')
@@ -131,7 +136,7 @@ class ModuleError(TwitchioException):
131136

132137

133138
class ModuleLoadFailure(ModuleError):
134-
"""An exception raised when a module failed to load during execution or `setup` entry point."""
139+
"""Exception raised when a module failed to load during execution or `setup` entry point."""
135140

136141
def __init__(self, name: str, exc: Exception) -> None:
137142
super().__init__(name, exc)
@@ -152,7 +157,7 @@ def __init__(self, msg: str) -> None:
152157

153158

154159
class ModuleNotLoadedError(ModuleError):
155-
"""An exception raised when a module was not loaded."""
160+
"""Exception raised when a module was not loaded."""
156161

157162
def __init__(self, msg: str) -> None:
158163
super().__init__(msg)

0 commit comments

Comments
 (0)