Skip to content

Commit

Permalink
Fix spellcheck on markdown (#23153)
Browse files Browse the repository at this point in the history
* Fix spellcheck on markdown

Problem

- There is no way to prevent spellcheck of all Markdown, even for
  generated files with lots of possibly non-English or otherwise
  auto-generated text that generally fails spell check.

Changes

- Add a method using embedded comments to temporarily disable spellcheck
  for blocks of Markdown - Remove `Description` column by default in CHIP
  error table to make it easier to print

Testing done
- CI finds no spell-checking errors.

* Fix spellcheck some more
  • Loading branch information
tcarmelveilleux authored and pull[bot] committed Jul 21, 2023
1 parent f476939 commit 2306816
Show file tree
Hide file tree
Showing 3 changed files with 338 additions and 325 deletions.
2 changes: 1 addition & 1 deletion .spellcheck.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,6 @@ matrix:
# converts markdown to HTML
- pyspelling.filters.markdown:
sources:
- '**/*.md|!third_party/**|!examples/common/**/repo/**'
- '**/*.md|!third_party/**|!examples/common/**/repo/**|!docs/ERROR_CODES.md'
aspell:
ignore-case: true
Loading

0 comments on commit 2306816

Please sign in to comment.