diff options
author | Philip Paquette <pcpaquette@gmail.com> | 2019-09-11 12:58:45 -0400 |
---|---|---|
committer | Philip Paquette <pcpaquette@gmail.com> | 2019-09-14 18:18:53 -0400 |
commit | abb42dcd4886705d6ba8af27f68ef605218ac67c (patch) | |
tree | 9ae16f7a09fff539fa72e65198e284bca6ac3376 /diplomacy/utils/errors.py | |
parent | a954a00d263750c279dbb2c0a9ae85707022bcd7 (diff) |
Added ReadtheDocs documentation for the public API
- Reformatted the docstring to be compatible
- Added tests to make sure the documentation compiles properly
- Added sphinx as a pip requirement
Co-authored-by: Philip Paquette <pcpaquette@gmail.com>
Co-authored-by: notoraptor <stevenbocco@gmail.com>
Diffstat (limited to 'diplomacy/utils/errors.py')
-rw-r--r-- | diplomacy/utils/errors.py | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/diplomacy/utils/errors.py b/diplomacy/utils/errors.py index 64e760e..1a63bb1 100644 --- a/diplomacy/utils/errors.py +++ b/diplomacy/utils/errors.py @@ -31,6 +31,7 @@ class MapError(Error): """ Represents a map error """ def __init__(self, code, message): """ Build a MapError + :param code: int code of the error :param message: human readable string message associated to the error """ @@ -40,6 +41,7 @@ class GameError(Error): """ Represents a game error """ def __init__(self, code, message): """ Build a GameError + :param code: int code of the error :param message: human readable string message associated to the error """ @@ -49,6 +51,7 @@ class StdError(Error): """ Represents a standard error """ def __init__(self, code, message): """ Build a StdError + :param code: int code of the error :param message: human readable string message associated to the error """ |