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

Switch all help docs to third person singular form #4542

Open
johnbillion opened this Issue Dec 2, 2017 · 6 comments

Comments

6 participants
@johnbillion
Contributor

johnbillion commented Dec 2, 2017

The help docs for WP-CLI commands includes a mixture of first person and third person verbiage.

For example, the description for wp help cache is Manipulate the WP Object Cache object, but the description for wp help cap is Adds, removes, and lists capabilities of a user role.

The latter is the correct grammatical person to use, as per the core documentation standards.

Ref: https://core.trac.wordpress.org/ticket/36913

This was referenced Dec 5, 2017

@DrewAPicture

This comment has been minimized.

Show comment
Hide comment
@DrewAPicture

DrewAPicture Dec 9, 2017

I believe I've covered all of the commands at this point with the above linked PRs. Please let me know if I've missed anything.

DrewAPicture commented Dec 9, 2017

I believe I've covered all of the commands at this point with the above linked PRs. Please let me know if I've missed anything.

@schlessera

This comment has been minimized.

Show comment
Hide comment
@schlessera

schlessera Dec 9, 2017

Member

Wow, thanks for all that work, @DrewAPicture !

Member

schlessera commented Dec 9, 2017

Wow, thanks for all that work, @DrewAPicture !

@gitlost

This comment has been minimized.

Show comment
Hide comment
@gitlost

gitlost Jan 25, 2018

Contributor

Ok a lot of instances have been changed thanks to @DrewAPicture and others, but probably not all, so am thinking of removing this from the 1.5.0 milestone @schlessera ?

Contributor

gitlost commented Jan 25, 2018

Ok a lot of instances have been changed thanks to @DrewAPicture and others, but probably not all, so am thinking of removing this from the 1.5.0 milestone @schlessera ?

@schlessera

This comment has been minimized.

Show comment
Hide comment
@schlessera

schlessera Jan 29, 2018

Member

Yes, we should remove it. This will probably remain an on-going process for a while until we've detected every single offender.

Member

schlessera commented Jan 29, 2018

Yes, we should remove it. This will probably remain an on-going process for a while until we've detected every single offender.

@schlessera schlessera removed this from the 1.5.0 milestone Jan 29, 2018

@bethannon

This comment has been minimized.

Show comment
Hide comment
@bethannon

bethannon Oct 12, 2018

Hi Alain! You added the Hacktoberfest label recently, but the trac ticket looks closed. I'm not much for coding, but I'm happy to help with documentation editing. Still need help on this?

bethannon commented Oct 12, 2018

Hi Alain! You added the Hacktoberfest label recently, but the trac ticket looks closed. I'm not much for coding, but I'm happy to help with documentation editing. Still need help on this?

@schlessera

This comment has been minimized.

Show comment
Hide comment
@schlessera

schlessera Oct 15, 2018

Member

Hi Beth,
I think we haven't yet changed all of the single-person entries to third-person yet. If you can detect singular use in the documentation for the commands, PRs are of course always welcome.
It might make sense to first create a checklist with the different packages first, though, so we can check them off once they were controlled. Otherwise, it is difficult to know what has been verified already and what hasn't.

Member

schlessera commented Oct 15, 2018

Hi Beth,
I think we haven't yet changed all of the single-person entries to third-person yet. If you can detect singular use in the documentation for the commands, PRs are of course always welcome.
It might make sense to first create a checklist with the different packages first, though, so we can check them off once they were controlled. Otherwise, it is difficult to know what has been verified already and what hasn't.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment