while0pass avatar while0pass committed f5b76f5

Sweep up the typo mess for highlight[s]!

Comments (0)

Files changed (1)


 If you instantiate a custom fragmenter, you can set the character limit on it
-    sf = highlights.SentenceFragmenter(charlimit=100000)
+    sf = highlight.SentenceFragmenter(charlimit=100000)
     results.fragmenter = sf
 See below for information on customizing the highlights.
 returned in each snippet::
     # Show a maximum of 5 fragments from the document
-    print hit.highlight("content", top=5)
+    print hit.highlights("content", top=5)
 Fragment size
     are highlighting a short bit of text and don't need to fragment it.
 The different fragmenters have different options. For example, the default
-:class:`~whoosh.highlights.ContextFragmenter` lets you set the maximum
+:class:`~whoosh.highlight.ContextFragmenter` lets you set the maximum
 fragment size and the size of the context to add on either side::
-    my_cf = highlights.ContextFragmenter(maxchars=100, surround=30)
+    my_cf = highlight.ContextFragmenter(maxchars=100, surround=30)
 See the :mod:`whoosh.highlight` docs for more information.
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.