Fix docstring types

edwardoughton · Mar 16, 2020 · 3168578 · 3168578
1 parent 8f57d38
commit 3168578
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/src/itmlogic/h0f.py b/src/itmlogic/h0f.py
@@ -16,7 +16,7 @@ def h0f(r, et):
 
     Returns
     -------
-    h0f1 : ???
+    h0f1 : float
         Frequency gain value used for computing path loss.
 
     """
@@ -43,6 +43,6 @@ def h0f(r, et):
         h0f1 = (
             (1 - q) * h0f1 + q * 4.343 *
             np.log((a[it] * x + b[it]) * x + 1)
-            )
+        )
 
     return h0f1
diff --git a/src/itmlogic/qerf.py b/src/itmlogic/qerf.py
@@ -11,8 +11,8 @@ def qerf(z):
         Defined value to assess the probability of exceedance of a standardized normal random
         variable.
 
-    Output
-    ------
+    Returns
+    -------
     qerfi1 : float
         The standard normal complementary probability
 

diff --git a/src/itmlogic/qerfi.py b/src/itmlogic/qerfi.py
@@ -8,12 +8,12 @@ def qerfi(q):
 
     Parameters
     ----------
-    q : list of floats(s)
+    q : list of float
         Confidence levels for predictions (e.g. [0.01, 0.1, 0.5, 0.9, 0.99])
 
-    Output
-    ------
-    qerfi1 : float
+    Returns
+    -------
+    qerfi1 : list of float
         Inverse of the standard normal complementary probability
 
     """