aboutsummaryrefslogtreecommitdiff
path: root/diplomacy/daide/server.py
diff options
context:
space:
mode:
authorPhilip Paquette <pcpaquette@gmail.com>2019-09-11 12:58:45 -0400
committerPhilip Paquette <pcpaquette@gmail.com>2019-09-14 18:18:53 -0400
commitabb42dcd4886705d6ba8af27f68ef605218ac67c (patch)
tree9ae16f7a09fff539fa72e65198e284bca6ac3376 /diplomacy/daide/server.py
parenta954a00d263750c279dbb2c0a9ae85707022bcd7 (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/daide/server.py')
-rw-r--r--diplomacy/daide/server.py4
1 files changed, 3 insertions, 1 deletions
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
"""