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/scheduler_event.py | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) (limited to 'diplomacy/utils/scheduler_event.py') diff --git a/diplomacy/utils/scheduler_event.py b/diplomacy/utils/scheduler_event.py index 1d097d8..8eaf0ff 100644 --- a/diplomacy/utils/scheduler_event.py +++ b/diplomacy/utils/scheduler_event.py @@ -19,12 +19,15 @@ from diplomacy.utils.jsonable import Jsonable class SchedulerEvent(Jsonable): - """ Scheduler event class. Properties: - - time_unit: unit time (in seconds) used by scheduler (time between 2 tasks checkings). + """ Scheduler event class. + + Properties: + + - **time_unit**: unit time (in seconds) used by scheduler (time between 2 tasks checkings). Currently 1 second in server scheduler. - - time_added: scheduler time (nb. time units) when data was added to scheduler. - - delay: scheduler time (nb. time units) to wait before processing time. - - current_time: current scheduler time (nb. time units). + - **time_added**: scheduler time (nb. time units) when data was added to scheduler. + - **delay**: scheduler time (nb. time units) to wait before processing time. + - **current_time**: current scheduler time (nb. time units). """ __slots__ = ['time_unit', 'time_added', 'delay', 'current_time'] model = { -- cgit v1.2.3