From a9641acc8e085730d02e9b13357c07a8510cfa92 Mon Sep 17 00:00:00 2001
From: Maxim Stewart <maximstewart1@gmail.com>
Date: Sat, 11 Apr 2020 15:00:22 -0500
Subject: [PATCH] Updated documentation.

---
 src/__init__.py                   | 8 ++++++++
 src/core/mixins/ControlerMixin.py | 2 +-
 src/core/utils/Browser.py         | 2 ++
 src/core/utils/Logger.py          | 4 ++--
 4 files changed, 13 insertions(+), 3 deletions(-)

diff --git a/src/__init__.py b/src/__init__.py
index 0b2493e..4120dc8 100644
--- a/src/__init__.py
+++ b/src/__init__.py
@@ -9,7 +9,15 @@ from core import Context
 
 
 class Main(Context):
+    """
+        This is the start that pulls the Context in and its mixins.
+        Load a command file from here or another class then call
+        respective method names and pass data as needed.
+    """
     def __init__(self, args):
+        """
+            Initialize it all...
+        """
         super().__init__(args)
 
         try:
diff --git a/src/core/mixins/ControlerMixin.py b/src/core/mixins/ControlerMixin.py
index 67ea313..dacd56f 100644
--- a/src/core/mixins/ControlerMixin.py
+++ b/src/core/mixins/ControlerMixin.py
@@ -37,7 +37,7 @@ class ControlerMixin:
 
     def createXPath(self, data):
         """
-            Don't call directly.
+            Don't call directly from a command file.
 
             :return: created xpath string
         """
diff --git a/src/core/utils/Browser.py b/src/core/utils/Browser.py
index 600384b..f048921 100644
--- a/src/core/utils/Browser.py
+++ b/src/core/utils/Browser.py
@@ -19,6 +19,8 @@ class Browser:
             :note: Should consider creating methods per browser type.
             :param browserType: The browser we want to use
             :param headless: If we have a gui or not
+
+            :return: the selenium browser driver
         """
         driver    = None
         _log_path = "./core/logs/webdriver.log"
diff --git a/src/core/utils/Logger.py b/src/core/utils/Logger.py
index e385c53..20bf93c 100644
--- a/src/core/utils/Logger.py
+++ b/src/core/utils/Logger.py
@@ -12,7 +12,7 @@ class Logger:
         """
             Create a new logging object and return it.
             :note:
-                NOSET     # Don't know the actual log level of this... (defaulting or litterally none?)
+                NOSET     # Don't know the actual log level of this... (defaulting or literally none?)
                 Log Levels (From least to most)
                 Type      Value
                 CRITICAL   50
@@ -23,7 +23,7 @@ class Logger:
             :param loggerName: Sets the name of the logger object. (Used in log lines)
             :param createFile: Whether we create a log file or just pump to terminal
 
-            :return: returns the logging object we created
+            :return: the logging object we created
         """
 
         globalLogLvl = logging.DEBUG    # Keep this at highest so that handlers can filter to their desired levels