Merge pull request #108 from UBC-MDS/implementation/qnorm

fix: updated qnorm documentation and test design - feedback addressed by Jason Lee
UBC-MDS · Jan 30, 2025 · 3990be5 · 3990be5
2 parents ab8cb84 + cb1f0c6
commit 3990be5
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/src/pystats_norm/qnorm.py b/src/pystats_norm/qnorm.py
@@ -11,12 +11,12 @@ def qnorm(p, mean=0, sd=1, lower_tail=True):
     Parameters
     ----------
     p: np.float64
-        The probability for which to find the quantile.
+        The probability for which to find the quantile. Must be between 0 and 1 (exclusive).
 
     mean: np.float64, optional
         The mean (average) of the normal distribution. Default is 0.
         
-    std_dev: np.float64, optional
+    sd: np.float64, optional
         The standard deviation of the normal distribution. Default is 1.
 
     lower_tail: bool, optional

diff --git a/tests/test_qnorm.py b/tests/test_qnorm.py
@@ -17,7 +17,9 @@ def test_output_datatype():
             (0.95, 0, 1, True, norm.ppf(0.95)),
             (0.95, 0, 1, False, norm.isf(0.95)),
             (0.99, 0, 1, True, norm.ppf(0.99)),
-            (0.99, 0, 1, False, norm.isf(0.99))
+            (0.99, 0, 1, False, norm.isf(0.99)),
+            (0.99, 10, 5, True, norm.ppf(0.99, 10, 5)),
+            (0.99, 10, 5, False, norm.isf(0.99, 10, 5))
         ]
 )
 def test_normal_cases(p, mean, sd, lower_tail, expected, tol=1e-6):