learn_mapreduce 0.1.0 → 0.1.1

data/lib/learn_mapreduce.rb

@@ -5,20 +5,45 @@ class MapReduce
       @reducer = nil
    end
    
-   # Call this function with a block to set the mapper function
-   # The mapper takes a record as argument
+   # Set the mapper function
+   #
+   # Example:
+   #   mr = MapReduce.new
+   #   mr.map do |record|
+   #     ...
+   #   end
+   #
+   # Arguments:
+   #   mapper: (block)
    def map &mapper
       @mapper = mapper
    end
    
-   # Call this function with a block to set the reducer function
-   # The reducer takes a key and a list of values as arguments
+   # Set the reducer function
+   #
+   # Example:
+   #   mr = MapReduce.new
+   #   mr.reduce do |key, list_of_values|
+   #     ...
+   #   end
+   #
+   # Arguments:
+   #   reducer: (block)
    def reduce &reducer
       @reducer = reducer
    end
    
    # Run a MapReduce algorithm on the data provided
-   # Returns a hash containing the emitted tuples, the shuffled tuples and the output
+   #
+   # Example:
+   #   mr = MapReduce.new
+   #   mr.run(data)
+   #
+   # Arguments:
+   #   data: (array)
+   #
+   # Returns:
+   #   [emitted, shuffled, output]
    def run data
       throw "Mapper missing!" unless @mapper
       throw "Reducer missing!" unless @reducer

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: learn_mapreduce
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors: