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

Expand cspell ignore instructions #2252

Merged
merged 9 commits into from
Jan 6, 2025
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
28 changes: 22 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -309,15 +309,31 @@ npm run check

There are two ways to deal with cSpell incorrectly complaining about a word, such as abbreviations.

1. Ignore the word in the local markdown file by adding a comment to the file, like below. The word is not case-sensitive, and the comment can be placed anywhere.
1. Ignore the word in the local file:

```
{/* cspell:ignore hellllooooo, ayyyyy */}
- For a markdown file, add a comment to the file, like below. The word is not case-sensitive, and the comment can be placed anywhere.

# Hellllooooo!
``` markdown
{/* cspell:ignore hellllooooo, ayyyyy */}

Ayyyyy, this is a fake description.
```
# Hellllooooo!

Ayyyyy, this is a fake description.
```

- For a Jupyter notebook, add the comment inside a markdown cell in the source part. Each line should be surrounded by quotes and end with "\n".

``` python
{
"cell_type": "markdown",
"id": "552b1077",
"metadata": {},
"source": [
"# Hello world\n",
"{/* cspell:ignore helloooooo */}\n"
]
},
```

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

Expand Down
Loading