lib/churn/churn_history.rb in churn-0.0.12 vs lib/churn/churn_history.rb in churn-0.0.13

@@ -1,13 +1,17 @@
 module Churn
 
+  # responcible for storing the churn history to json,
+  # and for loading old churn history data from json.
   class ChurnHistory
     
+    #takes current revision and it's hash_data and stores it
     def self.store_revision_history(revision, hash_data)
       FileUtils.mkdir 'tmp' unless File.directory?('tmp')
-      File.open("tmp/#{revision}.json", 'w') {|f| f.write(hash_data.to_json) }
+      File.open("tmp/#{revision}.json", 'w') {|file| file.write(hash_data.to_json) }
     end
 
+    #given a previous project revision find and load the churn data from a json file
     def self.load_revision_data(revision)
       #load revision data from scratch folder if it exists
       filename = "tmp/#{revision}.json"
       if File.exists?(filename)
         begin