summaryrefslogtreecommitdiff
path: root/swiftstory/exception.py
diff options
context:
space:
mode:
authorOlivier Gayot <olivier.gayot@sigexec.com>2021-12-29 19:21:45 +0100
committerOlivier Gayot <olivier.gayot@sigexec.com>2021-12-29 20:06:14 +0100
commit741f8234edde84dccefcbf5dc0ba3b70c0e016e2 (patch)
treec6207bfd9c20eeac59bea2ffef5d4fad70108c29 /swiftstory/exception.py
parentf5edd5035d06adc7b6bceb1f521b4911706cde0b (diff)
Add docstrings to all modules
Signed-off-by: Olivier Gayot <olivier.gayot@sigexec.com>
Diffstat (limited to 'swiftstory/exception.py')
-rw-r--r--swiftstory/exception.py11
1 files changed, 8 insertions, 3 deletions
diff --git a/swiftstory/exception.py b/swiftstory/exception.py
index 764289f..ad7a894 100644
--- a/swiftstory/exception.py
+++ b/swiftstory/exception.py
@@ -1,9 +1,14 @@
+""" Define a few exceptions types to be used. """
+
class WrongAction(Exception):
- pass
+ """ Exception to be raised when a player performs an action that is not
+ permitted. """
class UnsupportedLanguage(Exception):
- pass
+ """ Exception to be raised when trying to join a game in a language that is
+ not supported. """
+
class JoinError(Exception):
- pass
+ """ Exception to be raised when a game/room cannot be joined. """