aboutsummaryrefslogtreecommitdiff
path: root/diplomacy/daide/messages.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/messages.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/messages.py')
-rw-r--r--diplomacy/daide/messages.py1
1 files changed, 1 insertions, 0 deletions
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
"""