Documented the option :versions in description of method GridFileSystem.open.

2012-01-10 17:52:13 +01:00 · 2012-01-10 17:52:13 +01:00 · 585e6722b4
parent 417000da7b
commit 585e6722b4
1 changed files with 3 additions and 0 deletions
--- a/lib/mongo/gridfs/grid_file_system.rb
+++ b/lib/mongo/gridfs/grid_file_system.rb
@ -71,6 +71,9 @@ module Mongo
    #  GridFileSystem#delete.
    # @option opts [Boolean] :safe (false) When safe mode is enabled, the chunks sent to the server
    #   will be validated using an md5 hash. If validation fails, an exception will be raised.
+    # @option opts [Integer] :versions (false) deletes all versions which exceed the number specified to 
+    #   retain ordered by uploadDate. This option only works in 'w' mode. Certain precautions must be taken when 
+    #   deleting GridFS files. See the notes under GridFileSystem#delete.
    #
    # @example
    #