Commit 1497f6a9 authored by Amy Qualls's avatar Amy Qualls Committed by Diana Logan

Improve and expand wordiness test

Rewrite the wordiness test to allow more flexibility in the messages
returned, to allow words with similar problems to be grouped
together.

Moves the 'need to' test from SubstitutionWarning and makes it more
flexible.

Adds tests for 'note that' and 'please'.
parent 599956c6
...@@ -18,7 +18,6 @@ swap: ...@@ -18,7 +18,6 @@ swap:
file name: filename file name: filename
filesystem: file system filesystem: file system
info: information info: information
need to: must
repo: repository repo: repository
timezone: time zone timezone: time zone
utilize: use utilize: use
...@@ -5,9 +5,12 @@ ...@@ -5,9 +5,12 @@
# #
# For a list of all options, see https://docs.errata.ai/vale/styles # For a list of all options, see https://docs.errata.ai/vale/styles
extends: substitution extends: substitution
message: 'Be concise: "%s" is less wordy than "%s".' message: '%s "%s".'
link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html
level: suggestion level: suggestion
ignorecase: true ignorecase: true
swap: swap:
in order to: to in order to: "Be concise: use 'to' rather than"
needs? to: "Rewrite the sentence, or use 'must', instead of"
note that: "Be concise: rewrite the sentence to not use"
please: "Remove this word from the sentence: "
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment