summaryrefslogtreecommitdiff
path: root/swiftstory/cards.py
diff options
context:
space:
mode:
authorOlivier Gayot <olivier.gayot@sigexec.com>2021-12-29 19:21:45 +0100
committerOlivier Gayot <olivier.gayot@sigexec.com>2021-12-29 20:06:14 +0100
commit741f8234edde84dccefcbf5dc0ba3b70c0e016e2 (patch)
treec6207bfd9c20eeac59bea2ffef5d4fad70108c29 /swiftstory/cards.py
parentf5edd5035d06adc7b6bceb1f521b4911706cde0b (diff)
Add docstrings to all modules
Signed-off-by: Olivier Gayot <olivier.gayot@sigexec.com>
Diffstat (limited to 'swiftstory/cards.py')
-rw-r--r--swiftstory/cards.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/swiftstory/cards.py b/swiftstory/cards.py
index 7f28919..3c11f49 100644
--- a/swiftstory/cards.py
+++ b/swiftstory/cards.py
@@ -1,3 +1,5 @@
+""" Module that defines helpers to read cards from the filesystem. """
+
import json
import os
from typing import List
@@ -6,6 +8,8 @@ from pkg_resources import resource_stream
class Cards:
+ """ Dummy class that provides helper functions to retrieve the cards from
+ the FS. """
@staticmethod
def get_white_cards(lang: str) -> List[str]:
''' Read the file containing the white cards and return a list of cards '''