From 87526afe80fd3f41c2897f61eecfb9ecae35cd6a Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Sun, 29 Aug 2021 10:33:16 -0400 Subject: [PATCH] Try to improve advice --- .github/actions/spell-check/advice.md | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/.github/actions/spell-check/advice.md b/.github/actions/spell-check/advice.md index 2a32b65207..c83423a8ef 100644 --- a/.github/actions/spell-check/advice.md +++ b/.github/actions/spell-check/advice.md @@ -1,27 +1,25 @@ -
If you see a bunch of garbage +
If the flagged items do not appear to be text -If it relates to a ... -
well-formed pattern +If items relate to a ... +* well-formed pattern. -See if there's a [pattern](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns) that would match it. + 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. -If not, try writing one and adding it to the `patterns.txt` file. - -Patterns are Perl 5 Regular Expressions - you can [test]( + 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. -Note that patterns can't match multiline strings. -
-
binary-ish string + Note that patterns can't match multiline strings. -Please add a file path to the `excludes.txt` file instead of just accepting the garbage. +* binary file. -File paths are Perl 5 Regular Expressions - you can [test]( + Please add a file path to the `excludes.txt` file matching the containing file. + + 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. -`^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md]( + `^` 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). -
-- 2.47.2