From dd2c856dc072b81fc5bef7c46c26237274010679 Mon Sep 17 00:00:00 2001 From: John Schember Date: Tue, 22 Feb 2011 19:35:01 -0500 Subject: [PATCH] Comments. --- src/calibre/customize/__init__.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/src/calibre/customize/__init__.py b/src/calibre/customize/__init__.py index 9419f6454c..2edb7d7fd1 100644 --- a/src/calibre/customize/__init__.py +++ b/src/calibre/customize/__init__.py @@ -597,6 +597,17 @@ class StorePlugin(Plugin): # {{{ raise NotImplementedError() def search(self, query, max_results=10, timeout=60): + ''' + Searches the store for items matching query. This should + return items as a generator. + + :param query: The string query search with. + :param max_results: The maximum number of results to return. + :param timeout: The maximum amount of time in seconds to spend download the search results. + + :return: A tuple (cover_url, title, author, price, start_item). The start_item is plugin + specific and is used in :meth:`open` to open to a specifc place in the store. + ''' raise NotImplementedError() # }}}