MONGOID-4461 Encourage referring to MongoDB docs for supported map re…

…duce options
mongodb · Jul 28, 2017 · 6af6825 · 6af6825
1 parent c5fe473
commit 6af6825
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/lib/mongoid/contextual/map_reduce.rb b/lib/mongoid/contextual/map_reduce.rb
@@ -111,6 +111,7 @@ def js_mode
       end
 
       # Specifies where the map/reduce output is to be stored.
+      # Please see MongoDB documentation for supported map reduce options.
       #
       # @example Store output in memory.
       #   map_reduce.out(inline: 1)
@@ -124,6 +125,9 @@ def js_mode
       # @example Store output in a collection, reducing existing documents.
       #   map_reduce.out(reduce: "collection_name")
       #
+      # @example Return results from map reduce.
+      #   map_reduce.out(inline: 1)
+      #
       # @param [ Hash ] location The place to store the results.
       #
       # @return [ MapReduce ] The map/reduce object.