[wp-trac] [WordPress Trac] #57052: Revise use of "we" in comments to second person point of view
WordPress Trac
noreply at wordpress.org
Wed Nov 23 15:41:53 UTC 2022
#57052: Revise use of "we" in comments to second person point of view
----------------------------+---------------------
Reporter: ironprogrammer | Owner: (none)
Type: enhancement | Status: new
Priority: normal | Milestone: 6.2
Component: Text Changes | Version:
Severity: normal | Resolution:
Keywords: has-patch | Focuses:
----------------------------+---------------------
Comment (by SergeyBiryukov):
In [changeset:"54866" 54866]:
{{{
#!CommitTicketReference repository="" revision="54866"
Docs: Revise comments using “we” in WordPress root directory files.
This updates some inline comments to better match the guidelines and
recommendations set forth in the make/core and make/docs handbooks:
> In general, use second person in your documentation. Second person
depicts a friendly tone, with a perfect focus on the reader. In addition
to this, directly addressing the reader helps avoid passive voice; thereby
preventing unwanted confusion.
> ...
> the word “we” should be avoided (...) unless its made very clear which
group is speaking.
Includes:
* Replacing first-person usage of "we" with second person point of view.
* Making small clarification adjustments where the voice is much too
casual or lacks clear context, especially for non-native English speakers.
References:
* [https://make.wordpress.org/docs/style-guide/language-grammar
/grammatical-person/ Style Guide: Grammatical person]
* [https://make.wordpress.org/docs/handbook/documentation-team-handbook
/handbooks-style-and-formatting-guide/ Handbooks & HelpHub Style and
Formatting Guide]
* [https://make.wordpress.org/core/handbook/best-practices/post-comment-
guidelines/#style-and-substance Post & Comment Guidelines: Style and
Substance]
Follow-up to [2176], [3430], [4676], [6009], [7991], [12688], [12762],
[26008], [28978], [44488], [44962], [51979], [53131], [53132], [53156],
[53131], [54200].
Props ironprogrammer, costdev, jorbin, SergeyBiryukov.
See #57052.
}}}
--
Ticket URL: <https://core.trac.wordpress.org/ticket/57052#comment:8>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list