Skip to content

Commit

Permalink
Fix formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
kaelynj committed Feb 23, 2024
1 parent 4398a20 commit 87db602
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 9 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ There are two ways to deal with cSpell incorrectly complaining about a word, suc
Ayyyyy, this is a fake description.
```

2. If the word is a name, add it to the `cspell/dictionaries/people.txt` file. If it is a scientific or quantum specific word, add it to the `cspell/dictionaries/qiskit.txt` file. If it doesn't fit in either category, add it to the `words` section in `cspell/cSpell.json`. The word is not case-sensitive.
2. If the word is a name, add it to the `cspell/dictionaries/people.txt` file. If it is a scientific or quantum specific word, add it to the `cspell/dictionaries/qiskit.txt` file. If it doesn't fit in either category, add it to the `words` section in `cspell/cSpell.json`. The word is not case-sensitive.

If the word appears in multiple files, prefer the second approach to add it to one of the dictionaries or `cSpell.json`.

Expand Down
13 changes: 5 additions & 8 deletions cspell/cSpell.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@
{
"name": "qiskit",
"path": "dictionaries/qiskit.txt",
"addWords": true,
"addWords": true
},
{
"name": "people",
"path": "dictionaries/people.txt",
"addWords": true,
},
"addWords": true
}
],
"dictionaries": [
"qiskit",
Expand All @@ -24,12 +24,9 @@
"python-common",
"markdown",
"softwareTerms",
"scientific-terms-us",
],
"words": [
"Qiskit",
"qiskit",
"scientific-terms-us"
],
"words": ["Qiskit", "qiskit"],
"ignoreRegExpList": [
// Markdown links
"\\((.*)\\)",
Expand Down

0 comments on commit 87db602

Please sign in to comment.