-
Notifications
You must be signed in to change notification settings - Fork 86
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
base: main
Are you sure you want to change the base?
Conversation
README.md
Outdated
@@ -309,7 +309,7 @@ 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 markdown file by adding a comment to the file, like below. The word is not case-sensitive, and the comment can be placed anywhere (inside a markdown cell, in the source part). Note that in the text editor, each line is surrounded by quotes and ends with /n. So it looks like this: "{/* cspell:ignore hellllooooo, ayyyyy */}/n" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These new instructions only apply if it's a Jupyter notebook. I recommend something like this:
If the file is 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
.
Then you could add a second example code block with the language set to json
:
{
"cell_type": "markdown",
"id": "552b1077",
"metadata": {},
"source": [
"# Hello world\n",
"{/* cspell:ignore helloooooo */}\n"
]
},
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 (inside a markdown cell, in the source part). Note that in the text editor, each line is surrounded by quotes and ends with /n. So it looks like this: "{/* cspell:ignore hellllooooo, ayyyyy */}/n" | |
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 (inside a markdown cell, in the source part). Note that in the text editor, each line is surrounded by quotes and ends with \n. So it looks like this: "{/* cspell:ignore hellllooooo, ayyyyy */}\n" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@beckykd this is still unsolved. Frank's suggestion only fixed a typo and didn't yet apply my suggestion
Co-authored-by: Frank Harkins <[email protected]>
No description provided.