forked from Qiskit/documentation
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Reconfigure cspell to use dictionaries (Qiskit#873)
Closes Qiskit#827
- Loading branch information
Showing
6 changed files
with
307 additions
and
288 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
// This file is copied from IBM's closed source configuration. When updating it | ||
// here, also update the closed source repository, or ask a maintainer to do so | ||
// if you do not have access. | ||
{ | ||
"version": "0.2", | ||
"language": "en", | ||
"allowCompoundWords": true, | ||
"dictionaryDefinitions": [ | ||
{ | ||
"name": "qiskit", | ||
"path": "dictionaries/qiskit.txt", | ||
"addWords": true | ||
}, | ||
{ | ||
"name": "people", | ||
"path": "dictionaries/people.txt", | ||
"addWords": true | ||
} | ||
], | ||
"dictionaries": [ | ||
"qiskit", | ||
"people", | ||
"python", | ||
"python-common", | ||
"markdown", | ||
"softwareTerms", | ||
"scientific-terms-us" | ||
], | ||
"words": ["Qiskit", "qiskit"], | ||
"ignoreRegExpList": [ | ||
// Markdown links | ||
"\\((.*)\\)", | ||
// markdown code blocks. https://github.com/streetsidesoftware/vscode-spell-checker/issues/202#issuecomment-377477473 | ||
"/^\\s*```[\\s\\S]*?^\\s*```/gm", | ||
// inline code blocks. https://stackoverflow.com/questions/41274241/how-to-capture-inline-markdown-code-but-not-a-markdown-code-fence-with-regex | ||
"\\`([^\\`].*?)\\`", | ||
// $$ ... $$ code blocks | ||
"\\$\\$\n(?:.*\n)*?\\$\\$", | ||
// markdown metadata block. e.g. title, description, etc. | ||
"---\n(?:.*\n)*?---", | ||
// words inside curly braces. e.g. {word} | ||
"{\\w+}", | ||
// words inside colons. e.g. :word: | ||
":\\S+:", | ||
// words joined by underscores. e.g. hello_world, NEW_KEY_VALUE | ||
"\\S+_\\S+(_\\S+)*", | ||
// separate line <span id="" /> tags | ||
"^<span id=\\S+ />$", | ||
"^<span id=\\S+></span>$" | ||
], | ||
"ignorePaths": [ | ||
// We cannot easily control these API docs since they live in other repositories. | ||
"../docs/api/qiskit/**/*.md*", | ||
"../docs/api/qiskit-ibm-runtime/**/*.md*", | ||
"../docs/api/qiskit-ibm-provider/**/*.md*" | ||
] | ||
} |
Oops, something went wrong.