Chore: Fix Vale issues
requested to merge gitlab-community/gitlab:386931-fix-vale-issues-for-administration/operations/rails_console.md into master
What does this MR do and why?
Addresses documentation issues in administration/operations/rails_console.md.
Screenshots or screen recordings
Before correction
vale doc/administration/operations/rails_console.md
doc/administration/operations/rails_console.md
1:1 suggestion The grade level is 8.12. Aim gitlab.ReadingLevel
for 8th grade or lower by
using shorter sentences and
words.
20:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
24:21 warning Remove 'useful'. Be precise gitlab.Simplicity
instead of subjective.
133:7 warning Remove 'useful'. Be precise gitlab.Simplicity
instead of subjective.
133:26 warning Use 'in' instead of 'within' gitlab.SubstitutionWarning
when possible.
161:51 warning Instead of future tense 'will gitlab.FutureTense
generate', use present tense.
161:65 warning Remove 'useful'. Be precise gitlab.Simplicity
instead of subjective.
179:30 warning Instead of future tense 'will gitlab.FutureTense
be', use present tense.
179:43 warning Remove 'useful'. Be precise gitlab.Simplicity
instead of subjective.
187:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
235:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
331:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
428:9 suggestion Use 'please' only if we've gitlab.Wordy
inconvenienced the user.
468:52 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
468:52 warning Instead of 'This is', try gitlab.UnclearAntecedent
starting this sentence with a
specific subject and verb.
471:20 warning Instead of 'This is', try gitlab.UnclearAntecedent
starting this sentence with a
specific subject and verb.
471:20 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
513:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
523:77 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
526:30 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
540:1 warning Instead of 'This is', try gitlab.UnclearAntecedent
starting this sentence with a
specific subject and verb.
544:66 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
550:55 warning Use 'typical' or 'standard' gitlab.Normal
instead of 'normal'.
639:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
642:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
644:51 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
732:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
✖ 0 errors, 11 warnings and 16 suggestions in 1 file.
After correction
vale doc/administration/operations/rails_console.md
doc/administration/operations/rails_console.md
1:1 suggestion The grade level is 8.12. Aim gitlab.ReadingLevel
for 8th grade or lower by
using shorter sentences and
words.
20:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
24:21 warning Remove 'useful'. Be precise gitlab.Simplicity
instead of subjective.
133:7 warning Remove 'useful'. Be precise gitlab.Simplicity
instead of subjective.
133:26 warning Use 'in' instead of 'within' gitlab.SubstitutionWarning
when possible.
161:61 warning Remove 'useful'. Be precise gitlab.Simplicity
instead of subjective.
179:38 warning Remove 'useful'. Be precise gitlab.Simplicity
instead of subjective.
187:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
235:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
331:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
468:52 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
468:52 warning Instead of 'This is', try gitlab.UnclearAntecedent
starting this sentence with a
specific subject and verb.
471:20 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
471:20 warning Instead of 'This is', try gitlab.UnclearAntecedent
starting this sentence with a
specific subject and verb.
513:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
523:77 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
526:30 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
540:1 warning Instead of 'This is', try gitlab.UnclearAntecedent
starting this sentence with a
specific subject and verb.
544:66 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
639:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
642:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
644:51 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
732:1 suggestion Improve readability by using gitlab.SentenceLength
fewer than 25 words in this
sentence.
✖ 0 errors, 8 warnings and 15 suggestions in 1 file.How to set up and validate locally
Run vale doc/administration/operations/rails_console.md
MR acceptance checklist
This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.
-
I have evaluated the MR acceptance checklist for this MR.
/cc @sselhorn
Related to #386931 (closed)