Merge pull request #4 from gitwikc/development

Added comments in code

Author: gitwikc

dirmaker.py

@@ -2,11 +2,19 @@
 
 
 def make_file(parent_path: str, filename: str) -> None:
+    """
+    Creates a file in the given parent path
+    with the given filename
+    """
     with open(f"{parent_path}/{filename}", 'w') as f:
         f.close()
 
 
 def make_dir_tree(parent_path: str, tree: list) -> None:
+    """
+    Creates Creates a directory tree in the given parent path
+    with the given tree
+    """
     for i in tree:
         if type(i) == str:
             make_file(parent_path, i)

preprocess.py

@@ -2,7 +2,10 @@
 import argparse
 
 
-def get_args():
+def get_args() -> argparse.Namespace:
+    """
+    Gets the commanf line arguments
+    """
     ap = argparse.ArgumentParser()
 
     ap.add_argument('--root', '-r', type=str,
@@ -27,19 +30,36 @@ def get_tree(arg: str) -> List[object]:
     i = 0
     while i < len(arg):
         c = arg[i]
+        # Start of folder
         if c == '[':
+            # Stores contents of folder
             bracket_content = ''
+            # How far into the folder tree are we?
             bracket_depth = 1
+            # While still in the folder
             while bracket_depth > 0:
                 i += 1
                 bracket_content_token = arg[i]
+
+                # Another nested folder?
                 if bracket_content_token == '[':
-                    bracket_depth += 1
+                    bracket_depth += 1  # Go 1 step deeper
+
+                # Folder ends?
                 elif bracket_content_token == ']':
-                    bracket_depth -= 1
+                    bracket_depth -= 1  # Come out 1 step
+
+                # Still inside folder?
                 if bracket_depth > 0:
                     bracket_content += bracket_content_token
+
+            '''
+            Folder contents scanned,
+            create subtree now and save under current folder
+            '''
             tree.append({current_token: get_tree(bracket_content)})
+
+            # Clear current folder name for next folder/file
             current_token = ''
             i += 1
         elif c == "+" and len(current_token) > 0: