-
Notifications
You must be signed in to change notification settings - Fork 57
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added some phrasal verbs to avoid #809
Added some phrasal verbs to avoid #809
Conversation
Nice! need a fix here: ERROR: 1 in .vale/fixtures/RedHat/SimpleWords/testinvalid.adoc / .vale/styles/RedHat/SimpleWords.yml |
ad90f91
to
8cee84a
Compare
⚡️ Deploying PR Preview... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm nice work
@aireilly and @gaurav-nelson (@Chandralekha-RedHat for viz) Edit: Sorry, I'm seeing Aidan's comment above about this possible contradiction so you actually already covered it. MIssed that. However might be worth considering that both options have pros and cons and I'm not sure it's worth recommending one over the other for this reason. Wanted to call out that I think we've made a contradiction loop: I see pros and cons to both options: Speed up: Not ideal that it is a phrasal verb, however, it is the most common and simple phrase for this meaning |
@@ -12,7 +12,6 @@ swap: | |||
"objective(?! C?)": aim|goal | |||
absent: none|not here | |||
abundance: plenty | |||
accelerate: speed up | |||
accentuate: stress | |||
accompany: go with | |||
accomplish: carry out|do |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is another contradiction. Carry out is a phrasal verb, so accomplish would actually be preferred. Do is a good alternative though
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some other thoughts:
plenty: It's better to not put numerical descriptors at all (for example, what does "many applications" mean?) So maybe we shouldn't suggest abundance OR plenty.
absent: While I agree absent is a complicated word, it is often not going to match grammatically with "none" or "not here". For instance, "If the button is absent" != "*If the button is none" or "*If the button is not here" (not there would make sense in this example)
Also sorry, I know it's probably annoying I'm writing these comments after this PR was merged, so feel free to ignore me :D
I was going through Applying the IBM Style Guide in Writing Product Documentation and checked to see if out rules had that info covered.
accelerate
instead of speed up: