Changeset 55646 for trunk/src/wp-includes/class-wp-editor.php

Timestamp:

04/11/2023 10:04:58 PM (3 years ago)

Author:

audrasjb

Message:

Docs: Revise comments using “we” in various docblocks.

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.

References:

• ​Style Guide: Grammatical person
• ​Handbooks & HelpHub Style and Formatting Guide
• ​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], [54866].

Props majaloncar, leamcaleese, annebovelett.
Fixes #57052.

File:

• trunk/src/wp-includes/class-wp-editor.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-editor.php

@@ -1509 +1509 @@
      *
      * The compressed TinyMCE file cannot deal with custom themes, so this makes
-     * sure that we use the uncompressed TinyMCE file if a theme is defined.
-     * Even if we are on a production environment.
+     * sure that WordPress uses the uncompressed TinyMCE file if a theme is defined.
+     * Even if the website is running on a production environment.
      *
      * @since 5.0.0