Skip to content

Commit 8a71302

Browse files
authored
Update quickstart with dictionary format (#60)
Resolves #59
1 parent 9e298a5 commit 8a71302

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/source/quickstart.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,19 @@ dictionary:
205205
# export it out for later use!
206206
spell.export('my_custom_dictionary.gz', gzipped=True)
207207
208+
It is also possible to build a dictionary from other sources outside of pyspellchecker, it requires that the data be in the following format and saved as a json object:
209+
210+
.. code:: python
211+
212+
{
213+
"a": 1,
214+
"b": 2,
215+
"apple": 45,
216+
"bike": 60
217+
}
218+
219+
Note that the data does not need to be sorted!
220+
208221

209222
A quick, command line spell checking program
210223
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

0 commit comments

Comments
 (0)