Update GraphScaler documentation

quintel · Jan 12, 2017 · a3ea7ce · a3ea7ce
1 parent fdc9e3f
commit a3ea7ce
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/lib/atlas/scaler/graph_scaler.rb b/lib/atlas/scaler/graph_scaler.rb
@@ -22,11 +22,11 @@ def initialize(scaling_factor)
       @scaling_factor = scaling_factor
     end
 
-    # Public: Scales the demands in the graph - modifying the original graph!
+    # Public: Scales the demands in the graph hash - modifying the original hash!
     #
-    # graph - A Turbine::Graph containing nodes and edges.
+    # graph - A Hash containing nodes and edges.
     #
-    # Returns the graph itself.
+    # Returns the modified graph hash itself.
     def call(graph)
       SCALED_ATTRIBUTES.each do |graph_key, attributes|
         graph[graph_key].each_value do |record|
@@ -35,6 +35,7 @@ def call(graph)
           end
         end
       end
+      graph
     end
   end # Scaler::GraphScaler
 end # Atlas