testing docstrings

Author: Andrew Stewart

fundamentals_of_data_science/eda.py

@@ -5,6 +5,7 @@
 
 
 def display_dict(m, precision=3):
+    """Displays a dictionaray"""
     table = "<table>"
     for item in m.items():
         table += ("<tr><th>{0}</th><td>{1:." + str(precision) + "f}</td></tr>").format(*item)
@@ -13,12 +14,14 @@ def display_dict(m, precision=3):
 
 
 def calculate_tukey_five(data):
+    """Calculate Tukey"""
     min, q1, q2, q3, max = np.concatenate([[np.min(data)], stats.mstats.mquantiles( data, [0.25, 0.5, 0.75]),[np.max(data)]])
     data = {"Min": min, "Q1": q1, "Q2": q2, "Q3": q3, "Max": max}
     return data
 
 
 def calculate_tukey_dispersion(five):
+    """Calculate Tukey dispersion"""
     data = {
         "Range": five["Max"] - five["Min"],
         "IQR": five["Q3"] - five["Q1"],
@@ -28,6 +31,7 @@ def calculate_tukey_dispersion(five):
 
 
 def restyle_boxplot(patch):
+    """Restyle boxplot"""
     ## change color and linewidth of the whiskers
     for whisker in patch['whiskers']:
         whisker.set(color='#000000', linewidth=1)

fundamentals_of_data_science/models.py

@@ -40,6 +40,7 @@ def summarize(formula, X, y, model, style='linear'):
 
 
 def linear_regression(formula, data=None, style="linear", params={}):
+    """Linear regression"""
     if data is None:
         raise ValueError( "The parameter 'data' must be assigned a non-nil reference to a Pandas DataFrame")
 
@@ -84,6 +85,7 @@ def logistic(z):
 
 
 def logistic_regression( formula, data=None):
+    """Logistic regression"""
     if data is None:
         raise ValueError( "The parameter 'data' must be assigned a non-nil reference to a Pandas DataFrame")