From abb42dcd4886705d6ba8af27f68ef605218ac67c Mon Sep 17 00:00:00 2001 From: Philip Paquette Date: Wed, 11 Sep 2019 12:58:45 -0400 Subject: 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 Co-authored-by: notoraptor --- diplomacy/utils/errors.py | 3 +++ 1 file changed, 3 insertions(+) (limited to 'diplomacy/utils/errors.py') 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 """ -- cgit v1.2.3