|
1 | 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> |
2 | 3 |
|
3 | | -<details><summary>If you see a bunch of garbage</summary> |
| 4 | +If items relate to a ... |
| 5 | +* binary file (or some other file you wouldn't want to check at all). |
4 | 6 |
|
5 | | -If it relates to a ... |
6 | | -<details><summary>well-formed pattern</summary> |
| 7 | + Please add a file path to the `excludes.txt` file matching the containing file. |
7 | 8 |
|
8 | | -See if there's a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it. |
9 | | - |
10 | | -If not, try writing one and adding it to the `patterns.txt` file. |
| 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 | 11 |
|
12 | | -Patterns are Perl 5 Regular Expressions - you can [test]( |
13 | | -https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines. |
| 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 | 14 |
|
15 | | -Note that patterns can't match multiline strings. |
16 | | -</details> |
17 | | -<details><summary>binary-ish string</summary> |
| 15 | +* well-formed pattern. |
18 | 16 |
|
19 | | -Please add a file path to the `excludes.txt` file instead of just accepting the garbage. |
| 17 | + If you can write a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it, |
| 18 | + try adding it to the `patterns.txt` file. |
20 | 19 |
|
21 | | -File paths are Perl 5 Regular Expressions - you can [test]( |
22 | | -https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files. |
| 20 | + Patterns are Perl 5 Regular Expressions - you can [test]( |
| 21 | +https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your lines. |
23 | 22 |
|
24 | | -`^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md]( |
25 | | -../tree/HEAD/README.md) (on whichever branch you're using). |
26 | | -</details> |
| 23 | + Note that patterns can't match multiline strings. |
27 | 24 |
|
28 | 25 | </details> |
0 commit comments