Merge pull request #10 from bcrawford39GT/add_class_doc_updates

updated and fixed class docstring and modified class name to be the s…

Author: bcrawford39GT

examples_to_run/examples.py

@@ -1,13 +1,13 @@
-from github_tutorial.main_functions.main_functions  import math_function_class 
+from github_tutorial.main_functions.main_functions  import MathFunctionClass 
 
 # enter the two (2) values to use
 entered_value_0 = 100
 entered_value_1 = 2
 
-# set the math_function_class
-math_variable = math_function_class(entered_value_0, entered_value_1)
+# set the MathFunctionClass
+math_variable = MathFunctionClass(entered_value_0, entered_value_1)
 
-# print the math_variable (i.e., math_function_class) and list its type
+# print the math_variable (i.e., MathFunctionClass) and list its type
 print(f"\n")
 print(f"math_variable = {math_variable}")
 print(f"type(math_variable) = {type(math_variable)}\n")

examples_to_run/interactive_examples.py

@@ -1,19 +1,19 @@
 
 # to make each cell add '# %%' to the above section 
 # %%
-from github_tutorial.main_functions.main_functions  import math_function_class 
+from github_tutorial.main_functions.main_functions  import MathFunctionClass 
 
 # %%
 # enter the two (2) values to use
 entered_value_0 = 100
 entered_value_1 = 2
 
 # %%
-# set the math_function_class
-math_variable = math_function_class(entered_value_0, entered_value_1)
+# set the MathFunctionClass
+math_variable = MathFunctionClass(entered_value_0, entered_value_1)
 
 # %%
-# print the math_variable (i.e., math_function_class) and list its type
+# print the math_variable (i.e., MathFunctionClass) and list its type
 print(f"\n")
 print(f"math_variable = {math_variable}")
 print(f"type(math_variable) = {type(math_variable)}\n")

github_tutorial/__init__.py

@@ -1,6 +1,6 @@
 """The main math functions from this tutorial"""
 from github_tutorial.main_functions import main_functions
-from github_tutorial.main_functions.main_functions  import math_function_class 
+from github_tutorial.main_functions.main_functions  import MathFunctionClass 
 from github_tutorial.utils.math import (add_2_numbers, multiple_of_2_numbers)
 
 __version__ = "0.0.0"

github_tutorial/main_functions/__init__.py

@@ -1,3 +1,3 @@
 """main math functions"""
 from github_tutorial.utils.math import (add_2_numbers, multiple_of_2_numbers)
-from github_tutorial.main_functions.main_functions  import math_function_class 
+from github_tutorial.main_functions.main_functions  import MathFunctionClass 

github_tutorial/main_functions/main_functions.py

@@ -35,20 +35,40 @@ def _add_1_to_value(initial_value):
     return final_value
 
 # This is the main math Class 
-class math_function_class:
-    """Add 1 to to any value.
+class MathFunctionClass:
+    """Math class stores attributes/values and performs other functions. 
 
-        This function adds 1 to the entered value. 
+        This class stores the initial two (2) values, and also 
+        the initial two (2) values added and multiplied together. 
+        Additionally, it has a function that adds one(1) to each 
+        of the initial two (2) values and multiplies them together.
 
         Parameters
         ----------
         initial_value: int or float
             The first integer or float that 1 will be added to.
-        
-        Returns
+
+        Attributes
+        ----------
+        value_0: float or int
+            The first initial value entered in this class, which 
+            will be used in the math operations.
+        value_1: float or int
+            The second initial value entered in this class, which 
+            will be used in the math operations.  
+        added_numbers: float or int
+            The first and second initial values added together.
+        multiplied_numbers: float or int
+             The first and second initial values multiplied together. 
+
+        Methods
         -------
-        final_value: int or float
-            The initial value plus 1.
+        def __init__(self, value_0, value_1):
+            MathFunctionClass Class Constructor to initializes the object. 
+
+        def add_1_to_both_numbers_and_multiply(self):  int or float
+            This function adds 1 to each of value_0 and value_1 
+            and multiplies them together. 
     """
     def __init__(
         self,
@@ -58,13 +78,13 @@ def __init__(
 
         if not isinstance(value_0, (int, float)):
             raise TypeError(
-                f"ERROR: In the 'math_function_class' class, the {'value_0'} "
+                f"ERROR: In the 'MathFunctionClass' class, the {'value_0'} "
                 f"is a {type(value_0)} and not a int or float."
                 )
 
         if not isinstance(value_1, (int, float)):
             raise TypeError(
-                f"ERROR: In the 'math_function_class' class, the {'value_1'} "
+                f"ERROR: In the 'MathFunctionClass' class, the {'value_1'} "
                 f"is a {type(value_1)} and not a int or float."
                 )
 
@@ -77,12 +97,14 @@ def __init__(
     def add_1_to_both_numbers_and_multiply(self):
         """Add 1 to both value_0 and value_1 and multiply them together.
 
-        This function adds 1 to each of value_0 and value_1 and multiplies them together. 
+        This function adds 1 to each of value_0 and value_1 
+        and multiplies them together. 
 
         Returns
         -------
         add_1_to_both_numbers_and_multiply: int or float
-            This function adds 1 to each of value_0 and value_1 and multiplies them together. 
+            This function adds 1 to each of value_0 and value_1 
+            and multiplies them together. 
         """
 
         add_1_to_to_each_value_and_mulitipy = _add_1_to_value(self.value_0) * _add_1_to_value(self.value_1)

github_tutorial/tests/test_main_functions.py

@@ -2,7 +2,7 @@
 import pytest
 from github_tutorial.tests.base_test import BaseTest
 #from github_tutorial.utils.math import (add_2_numbers, multiple_of_2_numbers)
-from github_tutorial.main_functions.main_functions  import (math_function_class,  _add_1_to_value)
+from github_tutorial.main_functions.main_functions  import (MathFunctionClass,  _add_1_to_value)
 
 class TestMainFunction(BaseTest):
     def test__add_1_to_value_int(self):
@@ -67,11 +67,11 @@ def test__add_1_to_value_val_0_value_greater_equal_100000(self):
 
             value = _add_1_to_value(val_0)
 
-    def test_math_function_class(self):
+    def test_MathFunctionClass(self):
         val_0 = 1
         val_1 = 2
 
-        math_variable = math_function_class(val_0, val_1)
+        math_variable = MathFunctionClass(val_0, val_1)
 
         assert np.isclose(math_variable.added_numbers, 3)
         assert isinstance(math_variable.added_numbers, (int, float))
@@ -80,24 +80,24 @@ def test_math_function_class(self):
         assert np.isclose(math_variable.add_1_to_both_numbers_and_multiply(), 6)
         assert isinstance(math_variable.add_1_to_both_numbers_and_multiply(), (int, float))
 
-    def test_math_function_class_val_0_str(self):
+    def test_MathFunctionClass_val_0_str(self):
         with pytest.raises(
             TypeError,
-            match=f"ERROR: In the 'math_function_class' class, the value_0 is a {type('value_0')} "
+            match=f"ERROR: In the 'MathFunctionClass' class, the value_0 is a {type('value_0')} "
             f"and not a int or float",
         ):
             val_0 = '1.5'
             val_1 = 2.0
 
-            math_variable = math_function_class(val_0, val_1)
+            math_variable = MathFunctionClass(val_0, val_1)
 
-    def test_math_function_class_val_1_str(self):
+    def test_MathFunctionClass_val_1_str(self):
         with pytest.raises(
             TypeError,
-            match=f"ERROR: In the 'math_function_class' class, the value_1 is a {type('value_1')} "
+            match=f"ERROR: In the 'MathFunctionClass' class, the value_1 is a {type('value_1')} "
             f"and not a int or float",
         ):
             val_0 = 1.5
             val_1 = '2.0'
 
-            math_variable = math_function_class(val_0, val_1)
+            math_variable = MathFunctionClass(val_0, val_1)