Merge pull request #146 from CurricularAnalytics/add_credit_balance

add docstring for credit_balance()

Author: haydenfree

Project.toml

@@ -1,7 +1,7 @@
 name = "CurricularAnalytics"
 uuid = "593ffa3d-269e-5d81-88bc-c3b6809c35a6"
 authors = ["Greg Heileman <gregheileman@gmail.com>", "Hayden Free <haydenwfree@gmail.com>"]
-version = "1.5.1"
+version = "1.5.2"
 
 [deps]
 CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"

src/DegreePlanAnalytics.jl

@@ -140,7 +140,20 @@ function requisite_distance(plan::DegreePlan)
     return plan.metrics["requisite distance"] = distance
 end
 
-#TODO: write docstring, write tests
+"""
+    credit_balance(plan::DegreePlan)
+
+For a given degree plan `plan`, this function computes and returns the credit balance among the terms in a degree plan.  A 
+score of `0` indicates perfect balance, i.e., each term in the degree plan has the same number of credit hours. As a degree plan
+becomes more imbalanced, in terms of the number of credit hours in each tersm, the credit balance grows larger. If ``t_j`` 
+denotes the number of credit hours in term ``j``, ``j = 1 \ldots m,`` then the credit balance of degree plan `p`, denoted by
+``cb^p is given by:
+
+```math
+cb^p = \\sum_{i=1}^{m-1}\\abs(t_j - t_{j+1})
+```
+
+"""
 function credit_balance(plan::DegreePlan)
     bal = 0
     for i in 1:length(plan.terms)-1