From: Josh Soref <2119212+jsoref@users.noreply.github.com>
Date: Sun, 29 Aug 2021 14:33:16 +0000 (-0400)
Subject: Try to improve advice
X-Git-Tag: dnsdist-1.7.0-alpha1~44^2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=refs%2Fpull%2F10677%2Fhead;p=thirdparty%2Fpdns.git

Try to improve advice
---

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 @@
 <!-- See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice --> <!-- markdownlint-disable MD033 MD041 -->
-<details><summary>If you see a bunch of garbage</summary>
+<details><summary>If the flagged items do not appear to be text</summary>
 
-If it relates to a ...
-<details><summary>well-formed pattern</summary>
+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.
-</details>
-<details><summary>binary-ish string</summary>
+  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).
-</details>
 
 </details>