Skip to content

Commit

Permalink
Add another code example to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
LyubomirT committed Nov 27, 2023
1 parent bd8ebc5 commit d04afa4
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,16 @@ if not is_correct("reactjs") and get_similar("reactjs") is None:
pass
```

You can also extend the wordlist with multiple words at once by passing a list or a tuple to the function. Like this:

```python
from lesp import extend_wordlist

words = ["reactjs", "vuejs", "angularjs"]

extend_wordlist(words)
```

### Remove from wordlist

An opposite of the `extend_wordlist` function, this function removes a word from the wordlist. Note that this function will raise a `ValueError` if the word is not in the wordlist. Also note that this function will not remove the word from the wordlist permanently, it will only remove it for the current session. Here's an example:
Expand Down

0 comments on commit d04afa4

Please sign in to comment.