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/network_data.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/network_data.py')
| -rw-r--r-- | diplomacy/utils/network_data.py | 3 |
1 files changed, 1 insertions, 2 deletions
diff --git a/diplomacy/utils/network_data.py b/diplomacy/utils/network_data.py index 18e3869..d5fb5a3 100644 --- a/diplomacy/utils/network_data.py +++ b/diplomacy/utils/network_data.py @@ -15,14 +15,13 @@ # with this program. If not, see <https://www.gnu.org/licenses/>. # ============================================================================== """ Abstract Jsonable class to create data intended to be exchanged on network. + Used for requests, responses and notifications. To write a sub-class, you must first write a base class for data category (e.g. notifications): - Define header model for network data. - - Define ID field for data category (e.g. "notification_id"). This will be used to create unique identifier for every data exchanged on network. - - Then every sub-class from base class must define parameters (params) model. Params and header must not share any field. """ |