Skip to content
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

Merged
merged 1 commit into from
Jun 20, 2024

Conversation

gaurav-nelson
Copy link
Contributor

I was going through Applying the IBM Style Guide in Writing Product Documentation and checked to see if out rules had that info covered.

  • Also, we recommend using accelerate instead of speed up:
    image

Copy link

Click here to review and test in web IDE: Contribute

@aireilly
Copy link
Member

Nice! need a fix here:

ERROR: 1 in .vale/fixtures/RedHat/SimpleWords/testinvalid.adoc / .vale/styles/RedHat/SimpleWords.yml

Copy link

⚡️ Deploying PR Preview...

Copy link
Member

@aireilly aireilly left a 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 aireilly merged commit d690c63 into redhat-documentation:main Jun 20, 2024
4 checks passed
@chloeredhat
Copy link

chloeredhat commented Jun 25, 2024

@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:
Screenshot 2024-06-25 at 10 13 36 AM

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
Accelerate: Might be better for translation because it's not a phrasal verb, but it is a complex and less simple alternative which also isn't ideal

@@ -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

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

@aireilly @gaurav-nelson @Chandralekha-RedHat

Copy link

@chloeredhat chloeredhat Jun 25, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants