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/order_results.py | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'diplomacy/utils/order_results.py') diff --git a/diplomacy/utils/order_results.py b/diplomacy/utils/order_results.py index fea2773..9720cfe 100644 --- a/diplomacy/utils/order_results.py +++ b/diplomacy/utils/order_results.py @@ -15,6 +15,7 @@ # with this program. If not, see . # ============================================================================== """ Results + - Contains the results labels and code used by the engine """ from diplomacy.utils.common import StringableCode @@ -26,17 +27,35 @@ class OrderResult(StringableCode): """ Represents an order result """ def __init__(self, code, message): """ Build a Order Result + :param code: int code of the order result :param message: human readable string message associated to the order result """ super(OrderResult, self).__init__(code, message) OK = OrderResult(0, '') +"""Order result OK, printed as ``''``""" + NO_CONVOY = OrderResult(ORDER_RESULT_OFFSET + 1, 'no convoy') +"""Order result NO_CONVOY, printed as ``'no convoy'``""" + BOUNCE = OrderResult(ORDER_RESULT_OFFSET + 2, 'bounce') +"""Order result BOUNCE, printed as ``'bounce'``""" + VOID = OrderResult(ORDER_RESULT_OFFSET + 3, 'void') +"""Order result VOID, printed as ``'void'``""" + CUT = OrderResult(ORDER_RESULT_OFFSET + 4, 'cut') +"""Order result CUT, printed as ``'cut'``""" + DISLODGED = OrderResult(ORDER_RESULT_OFFSET + 5, 'dislodged') +"""Order result DISLODGED, printed as ``'dislodged'``""" + DISRUPTED = OrderResult(ORDER_RESULT_OFFSET + 6, 'disrupted') +"""Order result DISRUPTED, printed as ``'disrupted'``""" + DISBAND = OrderResult(ORDER_RESULT_OFFSET + 7, 'disband') +"""Order result DISBAND, printed as ``'disband'``""" + MAYBE = OrderResult(ORDER_RESULT_OFFSET + 8, 'maybe') +"""Order result MAYBE, printed as ``'maybe'``""" -- cgit v1.2.3