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/utils/tests/test_jsonable_changes.py | 7 ++++---
diplomacy/utils/tests/test_parsing.py | 2 +-
2 files changed, 5 insertions(+), 4 deletions(-)
(limited to 'diplomacy/utils/tests')
diff --git a/diplomacy/utils/tests/test_jsonable_changes.py b/diplomacy/utils/tests/test_jsonable_changes.py
index 992a8fb..2f37db3 100644
--- a/diplomacy/utils/tests/test_jsonable_changes.py
+++ b/diplomacy/utils/tests/test_jsonable_changes.py
@@ -103,9 +103,10 @@ class Version22(Jsonable):
class Version3(Jsonable):
""" Version 1 with a modified, b removed, e added.
To parse a dict between Version3 and Version1:
- - a must be convertible in both versions.
- - b must be optional in Version1.
- - e must be optional in Version3.
+
+ - a must be convertible in both versions.
+ - b must be optional in Version1.
+ - e must be optional in Version3.
"""
model = {
'a': parsing.ConverterType(str, converter_function=str),
diff --git a/diplomacy/utils/tests/test_parsing.py b/diplomacy/utils/tests/test_parsing.py
index f64ad26..f96a981 100644
--- a/diplomacy/utils/tests/test_parsing.py
+++ b/diplomacy/utils/tests/test_parsing.py
@@ -21,7 +21,7 @@ from diplomacy.utils.sorted_set import SortedSet
from diplomacy.utils.tests.test_common import assert_raises
from diplomacy.utils.tests.test_jsonable import MyJsonable
-class MyStringable():
+class MyStringable:
""" Example of Stringable class.
As instances of such class may be used as dict keys, class should define a proper __hash__().
"""
--
cgit v1.2.3