Make WordPress Core


Ignore:
Timestamp:
11/23/2022 03:41:39 PM (20 months ago)
Author:
SergeyBiryukov
Message:

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:

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.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-trackback.php

    r54658 r54866  
    7777}
    7878
    79 // Now that mb_convert_encoding() has been given a swing, we need to escape these three.
     79// Escape values to use in the trackback.
    8080$title     = wp_slash( $title );
    8181$excerpt   = wp_slash( $excerpt );
Note: See TracChangeset for help on using the changeset viewer.