advice.md (1220B)
1 <!-- See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice --> <!-- markdownlint-disable MD033 MD041 --> 2 <details><summary>If the flagged items are :exploding_head: false positives</summary> 3 4 If items relate to a ... 5 * binary file (or some other file you wouldn't want to check at all). 6 7 Please add a file path to the `excludes.txt` file matching the containing file. 8 9 File paths are Perl 5 Regular Expressions - you can [test]( 10 https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files. 11 12 `^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md]( 13 ../tree/HEAD/README.md) (on whichever branch you're using). 14 15 * well-formed pattern. 16 17 If you can write a [pattern]( 18 https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns 19 ) that would match it, 20 try adding it to the `patterns.txt` file. 21 22 Patterns are Perl 5 Regular Expressions - you can [test]( 23 https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines. 24 25 Note that patterns can't match multiline strings. 26 27 </details> 28 <!-- 29 template: check-spelling 30 -->