Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
rfsaldanha committed Mar 19, 2024
1 parent 6517815 commit 9f01b2b
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 6 deletions.
8 changes: 6 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,22 @@ Possible grammar errors will be shown at the console, and you will be asked to m

## Language selection

The package will observe if a language was set on project configuration. Set this option, even for English.
The package will prioritize the spelling dictionary set on project configuration.

Tools --> Project Options... --> Spelling --> Main dictionary language

If this is not defined (`Default` option), the package will let the LanguageTool API try to determine the language based on the text.
If not set, the project will use the spelling dictionary set on the Global Options.

Tools --> Global Options... --> Spelling --> Main dictionary language

You can also manually specify the language ([available options](https://api.languagetoolplus.com/v2/languages) at the API).

```{r eval=FALSE}
rspell::check_selection(language = "FR")
```

If you set `language = "auto"`, the LanguageTool API will try to guess the language.

## Add-in and keyboard shortcut

For a faster use, you can use the package's RStudio add-in. After installing the package, it will be available at the add-in list. You can also map a [keyboard shortcut](https://support.posit.co/hc/en-us/articles/206382178-Customizing-Keyboard-Shortcuts-in-the-RStudio-IDE) for it, like `Ctrl+g`.
Expand Down
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,15 @@ asked to modify or not the text.

## Language selection

The package will observe if a language was set on project configuration.
Set this option, even for English.
The package will prioritize the spelling dictionary set on project
configuration.

Tools –\> Project Options… –\> Spelling –\> Main dictionary language

If this is not defined (`Default` option), the package will let the
LanguageTool API try to determine the language based on the text.
If not set, the project will use the spelling dictionary set on the
Global Options.

Tools –\> Global Options… –\> Spelling –\> Main dictionary language

You can also manually specify the language ([available
options](https://api.languagetoolplus.com/v2/languages) at the API).
Expand All @@ -50,6 +52,9 @@ options](https://api.languagetoolplus.com/v2/languages) at the API).
rspell::check_selection(language = "FR")
```

If you set `language = "auto"`, the LanguageTool API will try to guess
the language.

## Add-in and keyboard shortcut

For a faster use, you can use the package’s RStudio add-in. After
Expand Down

0 comments on commit 9f01b2b

Please sign in to comment.