Skip to content

Commit

Permalink
update quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
barrust committed Sep 28, 2018
1 parent d9f8151 commit 87afefa
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion docs/source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ parameter on initialization.
print(spell['mañana'])
Adding Terms to a Dictionary
Adding and Removing Terms from a Dictionary
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

There are several ways to add additional terms to your word frequency dictionary
Expand Down Expand Up @@ -141,3 +141,26 @@ Or update using a list of words:
spell = SpellChecker()
spell.word_frequency.load_words(['Text', 'to', 'be','added', 'to', 'the', 'system'])
Or add a single word:

.. code:: python
from spellchecker import SpellChecker
spell = SpellChecker()
spell.word_frequency.add('Text')
Removing words is as simple as adding words:

.. code:: python
from spellchecker import SpellChecker
spell = SpellChecker()
spell.word_frequency.remove(['Text', 'to', 'be','removed', 'from', 'the', 'system'])
# or remove a single word
spell.remove('meh')

0 comments on commit 87afefa

Please sign in to comment.