Skip to content

Commit

Permalink
Docs: Revise comments using “we” in WordPress root directory files.
Browse files Browse the repository at this point in the history
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.
Built from https://develop.svn.wordpress.org/trunk@54866


git-svn-id: http://core.svn.wordpress.org/trunk@54418 1a063a9b-81f0-0310-95a4-ce76da25c4cd
  • Loading branch information
SergeyBiryukov committed Nov 23, 2022
1 parent abe134c commit 665719b
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 18 deletions.
4 changes: 2 additions & 2 deletions wp-cron.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
header( 'Cache-Control: no-cache, must-revalidate, max-age=0' );
}

/* 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();
} elseif ( function_exists( 'litespeed_finish_request' ) ) {
Expand All @@ -35,7 +35,7 @@
}

/**
* Tell WordPress we are doing the cron task.
* Tell WordPress the cron task is running.
*
* @var bool
*/
Expand Down
2 changes: 1 addition & 1 deletion wp-includes/version.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
*
* @global string $wp_version
*/
$wp_version = '6.2-alpha-54865';
$wp_version = '6.2-alpha-54866';

/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
Expand Down
6 changes: 1 addition & 5 deletions wp-load.php
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,7 @@

$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 );
exit;
Expand Down
2 changes: 1 addition & 1 deletion wp-login.php
Original file line number Diff line number Diff line change
Expand Up @@ -1244,7 +1244,7 @@ function wp_login_viewport_meta() {
)
);
} 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',
sprintf(
Expand Down
2 changes: 1 addition & 1 deletion wp-mail.php
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@
echo "\n" . $post_ID->get_error_message();
}

// 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;
}
Expand Down
12 changes: 6 additions & 6 deletions wp-settings.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
* Version information for the current WordPress release.
*
* 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.
* @global int $wp_db_version WordPress database version.
Expand Down Expand Up @@ -60,7 +60,7 @@
// Set initial default constants including WP_MEMORY_LIMIT, WP_MAX_MEMORY_LIMIT, WP_DEBUG, SCRIPT_DEBUG, WP_CONTENT_DIR and WP_CACHE.
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();

// WordPress calculates offsets from UTC.
Expand All @@ -70,13 +70,13 @@
// Standardize $_SERVER variables across setups.
wp_fix_server_vars();

// Check if we're in maintenance mode.
// Check if the site is in maintenance mode.
wp_maintenance();

// Start loading timer.
timer_start();

// Check if we're in WP_DEBUG mode.
// Check if WP_DEBUG mode is enabled.
wp_debug_mode();

/**
Expand Down Expand Up @@ -145,7 +145,7 @@

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;
}
Expand Down
2 changes: 1 addition & 1 deletion wp-trackback.php
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ function trackback_response( $error = 0, $error_message = '' ) {
$blog_name = mb_convert_encoding( $blog_name, get_option( 'blog_charset' ), $charset );
}

// 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 );
$blog_name = wp_slash( $blog_name );
Expand Down
2 changes: 1 addition & 1 deletion xmlrpc.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
*/
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();

// $HTTP_RAW_POST_DATA was deprecated in PHP 5.6 and removed in PHP 7.0.
Expand Down

0 comments on commit 665719b

Please sign in to comment.