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

SetStatus docs proofreading and 'apropriate' typos #362

Open
wants to merge 3 commits into
base: 4.4-trunk
Choose a base branch
from

Conversation

NReilingh
Copy link
Contributor

I initially just noticed the "scheam" typo in SetStatus.pm and was just going to submit that, but then I noticed that the rest of the docs in the same module could use an edit pass for clarity, spelling, and grammar.

I also noticed that "apropriate" was misspelled in a few other places, so I searched it in the codebase and corrected the other user-facing instances.

@NReilingh NReilingh force-pushed the action-docs-grammar branch from 1e8dd57 to 690f2bf Compare May 21, 2023 16:22
@sunnavy
Copy link
Member

sunnavy commented May 25, 2023

Hi Nick

I'm lean to merge the first commit and leave the 2 oxford comma commits as they are not quite necessary if you agree.

Thanks!

Regards
sunnavy

@NReilingh
Copy link
Contributor Author

@sunnavy

Nearly all formal style guides recommend the use of the serial ("Oxford") comma. Unless there's an official writing style guide for RT's docs that says something like "serial commas are discouraged", I treat them as an error when I do a proofreading/grammar pass on something.

But I don't think that's the case, since I've seen far more of the oxford comma in the rest of the writing in the docs. They should be added here to be consistent with the rest of the docs style.

@sunnavy
Copy link
Member

sunnavy commented Jun 11, 2023

Hi NReilingh

I'm ok to use oxford commas and I agree consistency is important. But instead of 2 commits that fix 2 oxford commas respectively, I prefer one commit that fixes all oxford commas in the whole codebase, and then I'll be happy to merge it.

Regards
sunnavy

@cbrandtbuffalo
Copy link
Member

As a status update, I'm fine with the comma fixes for docs. We're mostly focused on 5.0 now and this doesn't apply currently. I think that's mostly because we got the spelling fixes from the other branch we received that fixed all of our spelling errors: 464dacd1ac

So if you could branch from 5.0-trunk and include just the remaining issues/fixes we can try to merge again.

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.

3 participants