From abb42dcd4886705d6ba8af27f68ef605218ac67c Mon Sep 17 00:00:00 2001 From: Philip Paquette 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 Co-authored-by: notoraptor --- diplomacy/utils/network_data.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'diplomacy/utils/network_data.py') 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 . # ============================================================================== """ 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. """ -- cgit v1.2.3