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/server.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'diplomacy/daide/server.py') diff --git a/diplomacy/daide/server.py b/diplomacy/daide/server.py index ceca122..70324ed 100644 --- a/diplomacy/daide/server.py +++ b/diplomacy/daide/server.py @@ -27,7 +27,8 @@ LOGGER = logging.getLogger(__name__) class Server(TCPServer): """ Represents a server to receive DAIDE communications """ def __init__(self, master_server, game_id): - """ Contructor + """ Constructor + :param master_server: the internal server :param game_id: the game id for which this server will receive communications """ @@ -55,6 +56,7 @@ class Server(TCPServer): @gen.coroutine def handle_stream(self, stream, address): """ Handle an open stream + :param stream: the stream to handle :param address: the address of the client """ -- cgit v1.2.3