Changeset 54866

Timestamp:

11/23/2022 03:41:39 PM (23 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:

• ​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].

Props ironprogrammer, costdev, jorbin, SergeyBiryukov.
See #57052.

Location:

trunk/src

Files:

• wp-cron.php (modified) (2 diffs)
• wp-load.php (modified) (1 diff)
• wp-login.php (modified) (1 diff)
• wp-mail.php (modified) (1 diff)
• wp-settings.php (modified) (5 diffs)
• wp-trackback.php (modified) (1 diff)
• xmlrpc.php (modified) (1 diff)

trunk/src/wp-cron.php

@@ -24 +24 @@
 }
 
-/* Don't make the request block till we finish, if possible. */
+// Don't run cron until the request finishes, if possible.
 if ( PHP_VERSION_ID >= 70016 && function_exists( 'fastcgi_finish_request' ) ) {
     fastcgi_finish_request();
@@ -36 +36 @@
 
 /**
- * Tell WordPress we are doing the cron task.
+ * Tell WordPress the cron task is running.
  *
  * @var bool

trunk/src/wp-load.php

@@ -69 +69 @@
     $path = wp_guess_url() . '/wp-admin/setup-config.php';
 
-    /*
-     * We're going to redirect to setup-config.php. While this shouldn't result
-     * in an infinite loop, that's a silly thing to assume, don't you think? If
-     * we're traveling in circles, our last-ditch effort is "Need more help?"
-     */
+    // Redirect to setup-config.php.
     if ( false === strpos( $_SERVER['REQUEST_URI'], 'setup-config' ) ) {
         header( 'Location: ' . $path );

trunk/src/wp-login.php

@@ -1245 +1245 @@
                 );
             } elseif ( isset( $_POST['testcookie'] ) && empty( $_COOKIE[ TEST_COOKIE ] ) ) {
-                // If cookies are disabled, we can't log in even with a valid user and password.
+                // If cookies are disabled, the user can't log in even with a valid username and password.
                 $user = new WP_Error(
                     'test_cookie',

trunk/src/wp-mail.php

@@ -232 +232 @@
     }
 
-    // We couldn't post, for whatever reason. Better move forward to the next email.
+    // The post wasn't inserted or updated, for whatever reason. Better move forward to the next email.
     if ( empty( $post_ID ) ) {
         continue;

trunk/src/wp-settings.php

@@ -20 +20 @@
  *
  * These can't be directly globalized in version.php. When updating,
- * we're including version.php from another installation and don't want
- * these values to be overridden if already set.
+ * include version.php from another installation and don't override
+ * these values if already set.
  *
  * @global string $wp_version             The WordPress version string.
@@ -61 +61 @@
 wp_initial_constants();
 
-// Make sure we register the shutdown handler for fatal errors as soon as possible.
+// Register the shutdown handler for fatal errors as soon as possible.
 wp_register_fatal_error_handler();
 
@@ -71 +71 @@
 wp_fix_server_vars();
 
-// Check if we're in maintenance mode.
+// Check if the site is in maintenance mode.
 wp_maintenance();
 
@@ -77 +77 @@
 timer_start();
 
-// Check if we're in WP_DEBUG mode.
+// Check if WP_DEBUG mode is enabled.
 wp_debug_mode();
 
@@ -146 +146 @@
 register_shutdown_function( 'shutdown_action_hook' );
 
-// Stop most of WordPress from being loaded if we just want the basics.
+// Stop most of WordPress from being loaded if SHORTINIT is enabled.
 if ( SHORTINIT ) {
     return false;

trunk/src/wp-trackback.php

@@ -77 +77 @@
 }
 
-// Now that mb_convert_encoding() has been given a swing, we need to escape these three.
+// Escape values to use in the trackback.
 $title     = wp_slash( $title );
 $excerpt   = wp_slash( $excerpt );

trunk/src/xmlrpc.php

@@ -13 +13 @@
 define( 'XMLRPC_REQUEST', true );
 
-// Some browser-embedded clients send cookies. We don't want them.
+// Discard unneeded cookies sent by some browser-embedded clients.
 $_COOKIE = array();