Mercurial > wikked
changeset 308:31667edfb072
Some doc strings.
| author | Ludovic Chabant <ludovic@chabant.com> |
|---|---|
| date | Sat, 04 Oct 2014 21:05:39 -0700 |
| parents | e4e13e1138b2 |
| children | 4097bb36026a |
| files | wikked/indexer/base.py |
| diffstat | 1 files changed, 12 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/wikked/indexer/base.py Sat Oct 04 21:05:22 2014 -0700 +++ b/wikked/indexer/base.py Sat Oct 04 21:05:39 2014 -0700 @@ -8,25 +8,34 @@ class WikiIndex(object): - def __init__(self): - pass - + """ The search index for the wiki, allowing the user to run queries + to find pages. + """ def start(self, wiki): + """ Called when the wiki is started. """ pass def init(self, wiki): + """ Called when a new wiki is created. """ pass def postInit(self): + """ Called after a new wiki was created. """ pass def reset(self, pages): + """ Called when the index should be re-created from scratch + based on the given pages. """ pass def updatePage(self, page): + """ Called when the entry for the given page should be updated + with the latest information. """ pass def updateAll(self, pages): + """ Called when the entries for the given pages should be + updated with the latest information. """ pass def search(self, query):