document tests

Author: HalemoGPA

tests/test_function_plotter.py

@@ -12,7 +12,12 @@
 
 @pytest.fixture(scope="session")
 def app_instance():
-    """Fixture for creating a QApplication instance."""
+    """
+    Fixture for creating a QApplication instance.
+
+    Returns:
+    - QApplication: The QApplication instance.
+    """
     app = QApplication.instance()
     if app is None:
         app = QApplication([])
@@ -21,7 +26,16 @@ def app_instance():
 
 @pytest.fixture
 def function_plotter(app_instance, qtbot):
-    """Fixture for creating a FunctionPlotter instance."""
+    """
+    Fixture for creating a FunctionPlotter instance.
+
+    Parameters:
+    - app_instance (QApplication): The QApplication instance.
+    - qtbot (QtBot): The QtBot instance for simulating user interactions.
+
+    Returns:
+    - FunctionPlotter: The FunctionPlotter instance.
+    """
     plotter = FunctionPlotter()
     qtbot.addWidget(plotter)
     return plotter
@@ -31,6 +45,9 @@ def function_plotter(app_instance, qtbot):
 
 
 def test_valid_function_input(function_plotter, qtbot):
+    """
+    Test plotting a valid function.
+    """
     function_plotter.function_input.setText("5*x^3 + 2*x")
     function_plotter.min_input.setText("0")
     function_plotter.max_input.setText("10")
@@ -39,6 +56,9 @@ def test_valid_function_input(function_plotter, qtbot):
 
 
 def test_function_with_logarithm(function_plotter, qtbot):
+    """
+    Test plotting a function with a logarithm.
+    """
     function_plotter.function_input.setText("log10(x)")
     function_plotter.min_input.setText("1")
     function_plotter.max_input.setText("100")
@@ -47,6 +67,9 @@ def test_function_with_logarithm(function_plotter, qtbot):
 
 
 def test_function_with_square_root(function_plotter, qtbot):
+    """
+    Test plotting a function with a square root.
+    """
     function_plotter.function_input.setText("sqrt(x)")
     function_plotter.min_input.setText("0")
     function_plotter.max_input.setText("25")
@@ -55,6 +78,9 @@ def test_function_with_square_root(function_plotter, qtbot):
 
 
 def test_function_with_combined_operators(function_plotter, qtbot):
+    """
+    Test plotting a function with combined operators.
+    """
     function_plotter.function_input.setText("sqrt(x) + log10(x) + x^2")
     function_plotter.min_input.setText("1")
     function_plotter.max_input.setText("10")
@@ -63,6 +89,9 @@ def test_function_with_combined_operators(function_plotter, qtbot):
 
 
 def test_large_range_of_x(function_plotter, qtbot):
+    """
+    Test plotting a function over a large range of x values.
+    """
     function_plotter.function_input.setText("x^2")
     function_plotter.min_input.setText("-1000")
     function_plotter.max_input.setText("1000")
@@ -71,6 +100,9 @@ def test_large_range_of_x(function_plotter, qtbot):
 
 
 def test_small_range_of_x(function_plotter, qtbot):
+    """
+    Test plotting a function over a small range of x values.
+    """
     function_plotter.function_input.setText("x^2")
     function_plotter.min_input.setText("0")
     function_plotter.max_input.setText("1")
@@ -79,6 +111,9 @@ def test_small_range_of_x(function_plotter, qtbot):
 
 
 def test_negative_x_values(function_plotter, qtbot):
+    """
+    Test plotting a function with negative x values.
+    """
     function_plotter.function_input.setText("x^3")
     function_plotter.min_input.setText("-10")
     function_plotter.max_input.setText("0")
@@ -87,6 +122,9 @@ def test_negative_x_values(function_plotter, qtbot):
 
 
 def test_high_degree_polynomial(function_plotter, qtbot):
+    """
+    Test plotting a high-degree polynomial function.
+    """
     function_plotter.function_input.setText("x^6 - 2*x^4 + x^2")
     function_plotter.min_input.setText("-10")
     function_plotter.max_input.setText("10")
@@ -95,6 +133,9 @@ def test_high_degree_polynomial(function_plotter, qtbot):
 
 
 def test_floating_point_coefficients(function_plotter, qtbot):
+    """
+    Test floating point coefficients function.
+    """
     function_plotter.function_input.setText("0.5*x^2 + 2.5*x")
     function_plotter.min_input.setText("-5")
     function_plotter.max_input.setText("5")
@@ -103,6 +144,9 @@ def test_floating_point_coefficients(function_plotter, qtbot):
 
 
 def test_function_with_spaces(function_plotter, qtbot):
+    """
+    Test function with spaces.
+    """
     function_plotter.function_input.setText("  x ^ 2  +  3 * x ")
     function_plotter.min_input.setText("-5")
     function_plotter.max_input.setText("5")