Skip to content

Tweak vale template language for clarity

Marcel Amirault requested to merge docs-vale-template-message into master

What does this MR do and why?

The vale test outputs language like the following when it runs:

=> Linting prose...
doc/ci/jobs/job_control.md:
 Line 415, position 18 (rule gitlab.Repetition)
 error: "with" is repeated.
 More information: 

1 errors, 0 warnings, and 0 suggestions found in 1 file.

  ✖ ERROR: 'vale' failed with errors.

But this does not work well when the output finds no errors, as it says "found in 0 files", which is strange:

0 errors, 0 warnings, and 0 suggestions found in 0 files.

Let's drop the end of the sentence, as we don't need to know how many files have errors, it'll be clear by the number of error entries themselves, as each error lists the file. After updating the template, it now looks like this:

=> Linting prose...
0 errors, 0 warnings, and 0 suggestions found.

Screenshots or screen recordings

These are strongly recommended to assist reviewers and reduce the time to merge your change.

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Merge request reports