aboutsummaryrefslogtreecommitdiff
path: root/diplomacy/client/game_instances_set.py
diff options
context:
space:
mode:
authorPhilip Paquette <pcpaquette@gmail.com>2019-09-11 12:58:45 -0400
committerPhilip Paquette <pcpaquette@gmail.com>2019-09-14 18:18:53 -0400
commitabb42dcd4886705d6ba8af27f68ef605218ac67c (patch)
tree9ae16f7a09fff539fa72e65198e284bca6ac3376 /diplomacy/client/game_instances_set.py
parenta954a00d263750c279dbb2c0a9ae85707022bcd7 (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/client/game_instances_set.py')
-rw-r--r--diplomacy/client/game_instances_set.py3
1 files changed, 3 insertions, 0 deletions
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
"""