Skip to content

Commit

Permalink
docs: document tests
Browse files Browse the repository at this point in the history
  • Loading branch information
jolars committed Dec 8, 2023
1 parent 9752122 commit 027a2da
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions tests/test_basic.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
"""Basics tests for the slope function."""

import unittest

import numpy as np
Expand All @@ -7,7 +9,38 @@


class TestBasicUse(unittest.TestCase):
"""
A class used to test the basic use of the Slope model.
...
Attributes
----------
None
Methods
-------
test_simple_problem():
Tests a simple problem using the Slope model.
"""

def test_simple_problem(self):
"""
Tests a simple problem using the Slope model.
This method generates a random dataset using the numpy random module,
creates a Slope model with specific parameters, fits the model to the
generated data, and then checks if the model's coefficients are almost
equal to the expected coefficients.
Parameters
----------
None
Returns
-------
None
"""
n = 10
p = 3
rng = default_rng(4)
Expand Down

0 comments on commit 027a2da

Please sign in to comment.