2022-01-29 12:46:37 +00:00
|
|
|
<!-- See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice --> <!-- markdownlint-disable MD033 MD041 -->
|
2022-09-23 12:41:48 +00:00
|
|
|
<details><summary>If the flagged items are false positives</summary>
|
2022-01-29 12:46:37 +00:00
|
|
|
|
2022-09-23 12:41:48 +00:00
|
|
|
If items relate to a ...
|
|
|
|
|
* binary file (or some other file you wouldn't want to check at all).
|
2022-01-29 12:46:37 +00:00
|
|
|
|
2022-09-23 12:41:48 +00:00
|
|
|
Please add a file path to the `excludes.txt` file matching the containing file.
|
2022-01-29 12:46:37 +00:00
|
|
|
|
2022-09-23 12:41:48 +00:00
|
|
|
File paths are Perl 5 Regular Expressions - you can [test](
|
|
|
|
|
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files.
|
2022-01-29 12:46:37 +00:00
|
|
|
|
2022-09-23 12:41:48 +00:00
|
|
|
`^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md](
|
|
|
|
|
../tree/HEAD/README.md) (on whichever branch you're using).
|
2022-01-29 12:46:37 +00:00
|
|
|
|
2022-09-23 12:41:48 +00:00
|
|
|
* well-formed pattern.
|
2022-01-29 12:46:37 +00:00
|
|
|
|
2022-09-23 12:41:48 +00:00
|
|
|
If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it,
|
|
|
|
|
try adding it to the `patterns.txt` file.
|
2022-01-29 12:46:37 +00:00
|
|
|
|
2022-09-23 12:41:48 +00:00
|
|
|
Patterns are Perl 5 Regular Expressions - you can [test](
|
|
|
|
|
https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines.
|
2022-01-29 12:46:37 +00:00
|
|
|
|
2022-09-23 12:41:48 +00:00
|
|
|
Note that patterns can't match multiline strings.
|
2022-01-29 12:46:37 +00:00
|
|
|
|
|
|
|
|
</details>
|
