From 0ea1985ec45bceebf11fc341f324923511dad796 Mon Sep 17 00:00:00 2001 From: Samuel Attard Date: Wed, 26 Feb 2020 16:04:27 -0800 Subject: [PATCH] docs: improve documentation on spellchecker download URL (#22383) * docs: improve documentation on spellchecker download URL * Update session.md --- docs/api/session.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api/session.md b/docs/api/session.md index 38a1c368d16e..df5840caa75f 100644 --- a/docs/api/session.md +++ b/docs/api/session.md @@ -483,6 +483,10 @@ behavior you can use this API to point the dictionary downloader at your own hos dictionaries. We publish a `hunspell_dictionaries.zip` file with each release which contains the files you need to host here. +If the files present in `hunspell_dictionaries.zip` are available at `https://example.com/dictionaries/language-code.bdic` +then you should call this api with `ses.setSpellCheckerDictionaryDownloadURL('https://example.com/dictionaries/')`. Please +note the trailing slash. The URL to the dictionaries is formed as `${url}${filename}`. + **Note:** On macOS the OS spellchecker is used and therefore we do not download any dictionary files. This API is a no-op on macOS. #### `ses.listWordsInSpellCheckerDictionary()`