tools: add docs for prefer-util-format-errors rule

I had a little trouble understanding what the rule was trying to say, so
am documenting what would pass/fail.

PR-URL: #17376
Reviewed-By: Anatoli Papirovski <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>

Author: maclover7

tools/eslint-rules/prefer-util-format-errors.js

@@ -26,6 +26,11 @@ module.exports = {
         if (!isArrowFunctionWithTemplateLiteral(msg))
           return;
 
+        // Checks to see if order of arguments to function is the same as the
+        // order of them being concatenated in the template string. The idea is
+        // that if both match, then you can use `util.format`-style args.
+        // Would pass rule: (a, b) => `${b}${a}`.
+        // Would fail rule: (a, b) => `${a}${b}`, and needs to be rewritten.
         const { expressions } = msg.body;
         const hasSequentialParams = msg.params.every((param, index) => {
           const expr = expressions[index];