Matt Chaput avatar Matt Chaput committed e183a2b

Added docs and warning to obsolete SpellChecker class.

Comments (0)

Files changed (1)

src/whoosh/spelling.py

 """This module contains helper functions for correcting typos in user queries.
 """
 
+import warnings
 from collections import defaultdict
 from heapq import heappush, heapreplace
 
 
 class SpellChecker(object):
     """This feature is obsolete.
+    Use :meth:`whoosh.searching.Searcher.corrector` instead.
+    See the "Correcting errors in user queries" page in the user documentation.
     """
 
     def __init__(self, storage, indexname="SPELL",
                  booststart=2.0, boostend=1.0,
                  mingram=3, maxgram=4,
                  minscore=0.5):
+        warnings.warn("SpellChecker object is deprecated", DeprecationWarning)
         self.storage = storage
         self.indexname = indexname
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.