Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix several typos in docs/configuration/language-settings.md #5027

Merged
merged 1 commit into from
Dec 2, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/configuration/language-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ nav_order: 11

## LanguageSettings

The Language Settings allow configuration to be based upon the programming language and/or the e.
There are two selector fields `locale` and `languageId`.
The Language Settings allow configuration to be based upon the programming language and/or the locale.
There are two selector fields: `locale` and `languageId`.

- `languageId` defines which programming languages to match against.
A value of `"python,javascript"` will match against _python_ and _javascript_ files. To match against ALL programming languages,
use `"*"`.
- `locale` defines which spoken languages to match against. A value of `"en-GB,nl"` will match against British English or Dutch.
A value of `"*"` will match all spoken languages.
- Most configuration values allowed in a `cspell.json` file can be define or redefine within the `languageSettings`.
- Most configuration values allowed in a `cspell.json` file can be defined or redefined within the `languageSettings`.

```javascript
"languageSettings": [
Expand All @@ -35,7 +35,7 @@ There are two selector fields `locale` and `languageId`.
],
// List of dictionaries to enable by name in `dictionaryDefinitions`
"dictionaries": ["cpp"],
// Dictionary definitions can also be supplied here. They are only used iff "languageId" and "locale" match.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It makes sense to change, iff to if. It is a bit of programming jargon that means "If and Only If". But it is not needed in this context.

https://www.merriam-webster.com/dictionary/iff

// Dictionary definitions can also be supplied here. They are only used if "languageId" and "locale" match.
"dictionaryDefinitions": []
}
]
Expand Down
Loading