diff options
author | Philip Paquette <pcpaquette@gmail.com> | 2019-09-11 12:58:45 -0400 |
---|---|---|
committer | Philip Paquette <pcpaquette@gmail.com> | 2019-09-14 18:18:53 -0400 |
commit | abb42dcd4886705d6ba8af27f68ef605218ac67c (patch) | |
tree | 9ae16f7a09fff539fa72e65198e284bca6ac3376 /diplomacy/utils/tests/test_jsonable_changes.py | |
parent | a954a00d263750c279dbb2c0a9ae85707022bcd7 (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/utils/tests/test_jsonable_changes.py')
-rw-r--r-- | diplomacy/utils/tests/test_jsonable_changes.py | 7 |
1 files changed, 4 insertions, 3 deletions
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), |