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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Expand cspell ignore instructions #2252

wants to merge 1 commit into from

Conversation

beckykd
Copy link
Collaborator

@beckykd beckykd commented Nov 6, 2024

No description provided.

@beckykd beckykd marked this pull request as ready for review November 6, 2024 19:49
@@ -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"
Copy link
Collaborator

@Eric-Arellano Eric-Arellano Nov 6, 2024

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"
   ]
  },

Copy link
Member

@frankharkins frankharkins Nov 18, 2024

Choose a reason for hiding this comment

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

Suggested change
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"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

3 participants