Update docstrings

[lightcards.git] / lightcards / progress.py

diff --git a/lightcards/progress.py b/lightcards/progress.py
index bf78e0161a8349584ca7966ab77194a7876274a2..297895d2960735338ec580588d789c6285cdfc15 100644 (file)
--- a/lightcards/progress.py
+++ b/lightcards/progress.py
@@ -11,23 +11,27 @@ dired = f"{os.path.expanduser('~')}/.cache/lightcards/"
 
 
 def name_gen(stra):
+    """Generate hash of stack for name of pickle file"""
     hasher = hashlib.md5()
     hasher.update(str(stra).encode("utf-8"))
     return hasher.hexdigest()
 
 
 def make_dirs(dired):
+    """mkdir -p equivalent"""
     if not os.path.exists(dired):
         os.makedirs(dired)
 
 
 def dump(obj, stra):
+    """Write pickle file"""
     make_dirs(dired)
 
     pickle.dump(obj, open(f"{dired}/{name_gen(stra)}.p", "wb"))
 
 
 def dive(stra):
+    """Get pickle file"""
     file = f"{dired}/{name_gen(stra)}.p"
     make_dirs(dired)
     if os.path.exists(file):
@@ -37,6 +41,7 @@ def dive(stra):
 
 
 def purge(stra):
+    """Delete pickle file"""
     file = f"{dired}/{name_gen(stra)}/"
     if os.path.exists(file):
         shutil.rmtree(file)