From c70b79445eee447400f40516c3cdd7e164c474ba Mon Sep 17 00:00:00 2001 From: "A. Jesse Jiryu Davis" Date: Tue, 28 Oct 2014 16:22:43 -0400 Subject: [PATCH] GridFS.find_one docstring format. --- gridfs/__init__.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/gridfs/__init__.py b/gridfs/__init__.py index ba409bb6d..c1c28834d 100644 --- a/gridfs/__init__.py +++ b/gridfs/__init__.py @@ -284,18 +284,18 @@ class GridFS(object): All arguments to :meth:`find` are also valid arguments for :meth:`find_one`, although any `limit` argument will be - ignored. Returns a single :class:`~GridOut`, or ``None`` if no - matching file is found. For example:: + ignored. Returns a single :class:`~gridfs.grid_file.GridOut`, + or ``None`` if no matching file is found. For example:: file = fs.find_one({"filename": "lisa.txt"}) :Parameters: - - `spec_or_id` (optional): a dictionary specifying + - `spec_or_id` (optional): a dictionary specifying the query to be performing OR any other type to be used as the value for a query for ``"_id"`` in the file collection. - - `*args` (optional): any additional positional arguments are + - `*args` (optional): any additional positional arguments are the same as the arguments to :meth:`find`. - - `**kwargs` (optional): any additional keyword arguments + - `**kwargs` (optional): any additional keyword arguments are the same as the arguments to :meth:`find`. """ if spec_or_id is not None and not isinstance(spec_or_id, dict):