Add documentation to the fscore function

Author: Hugo Hromic

bcubed/__init__.py

@@ -23,5 +23,15 @@
 from bcubed.extended import recall
 
 def fscore(p_val, r_val, beta=1.0):
-    """Computes the F_{beta}-score of given precision and recall values."""
+    """Computes the F_{beta}-score of given precision and recall values.
+
+    Parameters
+    ==========
+    p_val: float
+        The precision value to use for the F-score
+    r_val: float
+        The recall value to to use for the F-score
+    beta: float
+        The beta parameter for computing the F-score
+    """
     return (1.0 + beta**2) * (p_val * r_val / (beta**2 * p_val + r_val))

bcubed/extended.py

@@ -33,7 +33,7 @@ def mult_recall(el1, el2, cdict, ldict):
 
 def precision(cdict, ldict):
     """Computes overall extended BCubed precision for the C and L dicts.
-    
+
     Parameters
     ==========
     cdict: dict(item: set(cluster-ids))
@@ -46,7 +46,7 @@ def precision(cdict, ldict):
 
 def recall(cdict, ldict):
     """Computes overall extended BCubed recall for the C and L dicts.
-    
+
     Parameters
     ==========
     cdict: dict(item: set(cluster-ids))