# HG changeset patch # User Ludovic Chabant # Date 1412481939 25200 # Node ID 31667edfb072b971bb0ba66d7587ae49e1789914 # Parent e4e13e1138b2fc450d9f115d7713e4e964d40ef4 Some doc strings. diff -r e4e13e1138b2 -r 31667edfb072 wikked/indexer/base.py --- 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):