Commits

Anonymous committed 34672a9

Fixed up RST in setup.py.

Comments (0)

Files changed (1)

 Web. This package is an extraction of the stemming code included in the Whoosh
 search engine.
 
+Note that these are *pure Python* implementations. Python wrappers for, e.g.
+the Snoball stemmers and the C implementation of the Porter stemmer are
+available on PyPI and will be faster if using compiled code is an option for
+you.
+
 Stemming algorithms attempt to automatically remove suffixes (and in some
 cases prefixes) in order to find the "root word" or stem of a given word. This
 is useful in various natural language processing scenarios, such as search.
 
 The ``stemming`` package contains modules for each algorithm (``lovins``,
 ``paicehusk``, ``porter``, and ``porter2``). Each module contains a ``stem()``
-function.
+function::
 
->> from stemming.porter2 import stem
->> stem("factionally")
-faction
+    >> from stemming.porter2 import stem
+    >> stem("factionally")
+    faction
 
 (The Paice-Husk algorithm allows custom stemming rule sets, so the
 ``paicehusk`` module also includes a ``PaiceHuskStemmer`` class you can