From 585e6722b4090a52d309ac9c91f49df2cd969f5d Mon Sep 17 00:00:00 2001 From: VvanGemert Date: Tue, 10 Jan 2012 17:52:13 +0100 Subject: [PATCH] Documented the option :versions in description of method GridFileSystem.open. --- lib/mongo/gridfs/grid_file_system.rb | 3 +++ 1 file changed, 3 insertions(+) diff --git a/lib/mongo/gridfs/grid_file_system.rb b/lib/mongo/gridfs/grid_file_system.rb index 2cd1ae4..c15c1fe 100644 --- 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 #