website icon indicating copy to clipboard operation
website copied to clipboard

Investigate method for excluding blocks of text in markdown from spell checking

Open roslynwythe opened this issue 8 months ago • 4 comments

Overview

As developers we need to investigate methods for excluding blocks of text in markdown files from spell checking, in order to avoid large numbers of false positives

Details

For HTML and JavaScript files, it is possible to exclude a portion of the text from spell checking, using specially formatted comments. Examples of such comments can be found here in the cspell documentation. However for markdown files the situation is different because since markdown does not support "comments", it is not clear which if any of those those methods can be used

Action Items

  • [ ] Read cspell - enable/disable checking sections of code and determine whether the techniques presented can be used in a markdown file. As a sample use the overview section of _guide-pages/how-to-set-reminders-in-slack.md
  • [ ] If successful and no "unknown word" warnings are generated by VS Code Spell Check Extension
    • [ ] verify the proper operation of the markdown text by checking the web page ??
    • [ ] add and commit _guide-pages/how-to-set-reminders-in-slack.md
    • [ ] in a comment in this issue, create a draft wiki page describing the method
  • [ ] If no method is found, create a comment detailing the research/testing in a comment in this issue, then move the issue to "Questions/In Review" column and apply "ready for dev lead" label

Resources

cspell - enable/disable checking sections of code

  • This issue resulted from #7004

roslynwythe avatar Jun 16 '24 19:06 roslynwythe