From 741f8234edde84dccefcbf5dc0ba3b70c0e016e2 Mon Sep 17 00:00:00 2001 From: Olivier Gayot Date: Wed, 29 Dec 2021 19:21:45 +0100 Subject: Add docstrings to all modules Signed-off-by: Olivier Gayot --- swiftstory/exception.py | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) (limited to 'swiftstory/exception.py') 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. """ -- cgit v1.2.3