Skip to content

Commit

Permalink
documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
barrust committed Sep 29, 2018
1 parent d8362eb commit 2bdb305
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ algorithm to find permutations within an edit distance of 2 from the
original word. It then compares all permutations (insertions, deletions,
replacements, and transpositions) to known words in a word frequency
list. Those words that are found more often in the frequency list are
***more likely*** the correct results.
**more likely** the correct results.

``pyspellchecker`` supports multiple languages including English, Spanish,
German, and French. Dictionaries were generated using the `WordFrequency project <https://github.com/hermitdave/FrequencyWords>`__ on GitHub.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -163,4 +163,4 @@ Removing words is as simple as adding words:
spell.word_frequency.remove_words(['Text', 'to', 'be','removed', 'from', 'the', 'system'])
# or remove a single word
spell.remove('meh')
spell.word_frequency.remove('meh')
4 changes: 2 additions & 2 deletions spellchecker/spellchecker.py
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ def edit_distance_1(self, word):
Args:
word (str): The word for which to calculate the edit distance
Returns:
set: The set of strings that are edit distance two from the \
set: The set of strings that are edit distance one from the \
provided word '''
if self._check_if_should_check(word) is False:
return {word}
Expand All @@ -148,7 +148,7 @@ def edit_distance_2(self, word):
Args:
word (str): The word for which to calculate the edit distance
Returns:
set: The set of strings that are edit distance one from the \
set: The set of strings that are edit distance two from the \
provided word '''
return (e2 for e1 in self.edit_distance_1(word)
for e2 in self.edit_distance_1(e1))
Expand Down

0 comments on commit 2bdb305

Please sign in to comment.