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/daide/connection_handler.py | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) (limited to 'diplomacy/daide/connection_handler.py') diff --git a/diplomacy/daide/connection_handler.py b/diplomacy/daide/connection_handler.py index 0b606bf..ab8d6cd 100644 --- a/diplomacy/daide/connection_handler.py +++ b/diplomacy/daide/connection_handler.py @@ -29,9 +29,12 @@ from diplomacy.utils import exceptions # Constants LOGGER = logging.getLogger(__name__) -class ConnectionHandler(): - """ ConnectionHandler class. Properties: - - server: server object representing running server. +class ConnectionHandler: + """ ConnectionHandler class. + + Properties: + + - **server**: server object representing running server. """ _NAME_VARIANT_PREFIX = 'DAIDE' _NAME_VARIANTS_POOL = [] @@ -54,6 +57,7 @@ class ConnectionHandler(): def initialize(self, stream, server, game_id): """ Initialize the connection handler. + :param server: a Server object. :type server: diplomacy.Server """ @@ -152,6 +156,7 @@ class ConnectionHandler(): def translate_notification(self, notification): """ Translate a notification to a DAIDE notification. + :param notification: a notification object to pass to handler function. See diplomacy.communication.notifications for possible notifications. :return: either None or an array of daide notifications. -- cgit v1.2.3