Skip to content

Commit 1e13187

Browse files
committed
minor: gridfs docs
1 parent 55ebf36 commit 1e13187

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

lib/mongo/gridfs/grid.rb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ def initialize(db, fs_name=DEFAULT_FS_NAME)
3939

4040
# Store a file in the file store.
4141
#
42+
# Note that arbitary metadata attributes can be saved to the file by passing
43+
# them is as options.
44+
#
4245
# @param [String, #read] data a string or io-like object to store.
4346
#
4447
# @options opts [String] :filename (nil) a name for the file.

lib/mongo/gridfs/grid_file_system.rb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@ def initialize(db, fs_name=Grid::DEFAULT_FS_NAME)
4343
# Open a file for reading or writing. Note that the options for this method only apply
4444
# when opening in 'w' mode.
4545
#
46+
# Note that arbitary metadata attributes can be saved to the file by passing
47+
# them is as options.
48+
#
4649
# @param [String] filename the name of the file.
4750
# @param [String] mode either 'r' or 'w' for reading from
4851
# or writing to the file.

0 commit comments

Comments
 (0)