Added Docstrings (#32)

* Added Docstrings

Fixes #22

Signed-off-by: afro-coder <[email protected]>

* Added Docstrings

Fixes #22

Signed-off-by: afro-coder <[email protected]>

* Updated docstring
Fixes #22

Signed-off-by: afro-coder <[email protected]>

* Added docstrings

This will hopefully fix the mix of tabs and spaces and will pass CI/CD too

Signed-off-by: afro-coder <[email protected]>

* Added docstrings

This will hopefully fix the mix of tabs and spaces and will pass CI/CD too

Signed-off-by: afro-coder <[email protected]>

Author: afro-coder

src/Action.py

@@ -1,4 +1,6 @@
 class Action:
+    """Define Action Class"""
+
     def __init__(self, expression: str):
         self.expression = expression
 

src/Actions.py

@@ -1,4 +1,6 @@
 class Actions:
+    """Define and check actions"""
+
     def __init__(self, actions=None):
         if actions is None:
             actions = []

src/Condition.py

@@ -1,4 +1,6 @@
 class Condition:
+    """Define a Condition Class"""
+
     def __init__(self, expression: str, result: str):
         self.expression = expression
         self.result = result

src/Conditions.py

@@ -1,4 +1,6 @@
 class Conditions:
+    """Define Conditions"""
+
     def __init__(self, conditions=None):
         if conditions is None:
             conditions = []

src/Event.py

@@ -3,6 +3,8 @@
 
 
 class Event:
+    """Construct an Event class"""
+
     def __init__(self, name: str, to_state: str, pre_conditions: Conditions, post_conditions: Conditions, pre_actions: Actions, post_actions: Actions):
         self.name = name
         self.to_state = to_state

src/State.py

@@ -1,4 +1,6 @@
 class State:
+    """Define the state class"""
+
     def __init__(self, name: str, events=None):
         if events is None:
             events = {}

tests/testBaseStateMachine.py

@@ -30,6 +30,7 @@ def printTest():
 
 
 class TestBaseStateMachine(unittest.TestCase):
+    """Test state machine using various samples"""
 
     def test1(self):