Adding a few docblocks

thtroyer · Mar 9, 2022 · e476ac4 · e476ac4
1 parent b24ae9e
commit e476ac4
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/simpletextgenerator/ui/new_job.py b/simpletextgenerator/ui/new_job.py
@@ -32,6 +32,7 @@ def draw_new_batch_job_window():
 
 
 class AbstractNewJobWindow(tk.Tk):
+    """Parent class for the 3 related UIs in this file."""
 
     def __init__(self):
         super().__init__()
@@ -193,6 +194,8 @@ def set_training_file_batch(self):
 
 
 class NewJobWindow(AbstractNewJobWindow):
+    """UI for completely new jobs."""
+
     def __init__(self):
         super().__init__()
 
@@ -258,6 +261,8 @@ def __init__(self):
 
 
 class NewJobWindowLoad(AbstractNewJobWindow):
+    """UI for new jobs, but continuing from an existing model."""
+
     def __init__(self):
         super().__init__()
 
@@ -328,6 +333,8 @@ def __init__(self):
 
 
 class NewJobWindowBatch(AbstractNewJobWindow):
+    """UI for new jobs, set up as a batch."""
+
     def __init__(self):
         super().__init__()