// cSpell:disable example

[bubbletroubles]

The example in the readme.md file says that // cSpell:disable syntax can be used.

However, that syntax is not an option in the Disable checking documentation a few lines above.

It would be good to clarify the example vs valid ways to disable spell checking.

[Jason3S]

@bubbletroubles,

The important part is cspell:disable, not how to create a comment.

For example if you want to disable the spell checker in a Markdown file, you would use:

Markdown

<!--- cspell:disable --->
This text is not checked.
<!--- cspell:enable --->
This text is checked.

Python:

# cspell:disable
example = "This text is not checked."
# cspell:enable
example2 = "This text is checked."

Is this what you were asking about?

[bubbletroubles]

Ah yes that makes sense., thanks @Jason3S .

I created a draft PR #2949 to update the example (I'm not sure if you want to merge it, but it sure would have helped me to have that info). Let me know if I should publish the PR for your review.

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.