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/client/game_instances_set.py | 3 +++ 1 file changed, 3 insertions(+) (limited to 'diplomacy/client/game_instances_set.py') diff --git a/diplomacy/client/game_instances_set.py b/diplomacy/client/game_instances_set.py index f8c22b9..fd50507 100644 --- a/diplomacy/client/game_instances_set.py +++ b/diplomacy/client/game_instances_set.py @@ -32,7 +32,9 @@ class GameInstancesSet(): def __init__(self, game_id): """ Initialize a game instances set. + :param game_id: game ID of game instances to store. + :type game_id: str """ self.game_id = game_id self.games = weakref.WeakValueDictionary() # {power name => NetworkGame} @@ -60,6 +62,7 @@ class GameInstancesSet(): def add(self, game): """ Add given game. + :param game: a NetworkGame object. :type game: diplomacy.client.network_game.NetworkGame """ -- cgit v1.2.3