From abb42dcd4886705d6ba8af27f68ef605218ac67c Mon Sep 17 00:00:00 2001
From: Philip Paquette <pcpaquette@gmail.com>
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 <pcpaquette@gmail.com>
Co-authored-by: notoraptor <stevenbocco@gmail.com>
---
diplomacy/daide/messages.py | 1 +
1 file changed, 1 insertion(+)
(limited to 'diplomacy/daide/messages.py')
diff --git a/diplomacy/daide/messages.py b/diplomacy/daide/messages.py
index d192d6e..30a037f 100644
--- a/diplomacy/daide/messages.py
+++ b/diplomacy/daide/messages.py
@@ -69,6 +69,7 @@ class DaideMessage(metaclass=ABCMeta):
@gen.coroutine
def from_stream(stream):
""" Builds a message from the stream
+
:param stream: An opened Tornado stream.
:type stream: tornado.iostream.BaseIOStream
"""
--
cgit v1.2.3