minor: doc

This commit is contained in:
Mike Dirolf 2009-07-08 11:43:25 -04:00
parent 2e4b1055b7
commit 1465bb1fea
2 changed files with 10 additions and 2 deletions

View File

@ -44,7 +44,11 @@ class GridFS(object):
"""Open a GridFile for reading or writing.
Shorthand method for creating / opening a GridFile from a filename. mode
must be a mode supported by `gridfs.grid_file.GridFile`
must be a mode supported by `gridfs.grid_file.GridFile`.
Only a single opened GridFile instance may exist for a file in gridfs
at any time. Care must be taken to close GridFile instances when done
using them.
:Parameters:
- `filename`: name of the GridFile to open

View File

@ -44,7 +44,11 @@ class GridFile(object):
"""Open a "file" in GridFS.
Application developers should generally not need to instantiate this
class directly.
class directly - instead see the `gridfs.open` method.
Only a single opened GridFile instance may exist for a file in gridfs
at any time. Care must be taken to close GridFile instances when done
using them.
Raises TypeError if file_spec is not an instance of dict, database is
not an instance of `pymongo.database.Database`, or collection is not an