Add docstrings to all modules

Signed-off-by: Olivier Gayot <olivier.gayot@sigexec.com>

1 files changed, 7 insertions, 0 deletions

diff --git a/swiftstory/player.py b/swiftstory/player.py
index 7243585..2df6882 100644
--- a/swiftstory/player.py
+++ b/swiftstory/player.py
@@ -1,9 +1,12 @@
+""" Module defining the player class. """
+
 import asyncio
 import json
 from typing import Any, Dict, Tuple
 
 
 class Player:
+    """ Represent a player. """
     def __init__(self) -> None:
         self.cards: Dict[int, Tuple[int, str]] = {}
         self.next_idx = 0
@@ -16,9 +19,11 @@ class Player:
         self.notifications: asyncio.Queue = asyncio.Queue()
 
     def pop_card(self, card_id: int) -> Tuple[int, str]:
+        """ Take and return the card at index card_id. """
         return self.cards.pop(card_id)
 
     def inc_score(self) -> None:
+        """ Increase the score by one. """
         self.score += 1
         self.register_notification({
             'op': 'updated_score',
@@ -26,11 +31,13 @@ class Player:
             })
 
     def receive_card(self, card: Tuple[int, str]) -> int:
+        """ Receive a card and return its index. """
         self.cards[self.next_idx] = card
         self.next_idx += 1
         return self.next_idx - 1
 
     def register_notification(self, obj: Any) -> None:
+        """ Register a notification to be picked up by the client. """
         message = json.dumps({'type': 'notification', 'content': obj})
 
         self.notifications.put_nowait(message)