From 5792276ddc861f798da89415a2133c01de2423bb Mon Sep 17 00:00:00 2001 From: Jb Audras Date: Tue, 11 Apr 2023 22:04:58 +0000 Subject: [PATCH] =?UTF-8?q?Docs:=20Revise=20comments=20using=20=E2=80=9Cwe?= =?UTF-8?q?=E2=80=9D=20in=20various=20docblocks.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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: - [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], [54866]. Props majaloncar, leamcaleese, annebovelett. Fixes #57052. git-svn-id: https://develop.svn.wordpress.org/trunk@55646 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/class-wp-editor.php | 4 ++-- src/wp-includes/class-wp-http-curl.php | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/wp-includes/class-wp-editor.php b/src/wp-includes/class-wp-editor.php index 48c8020c2a..911aa0ee24 100644 --- a/src/wp-includes/class-wp-editor.php +++ b/src/wp-includes/class-wp-editor.php @@ -1508,8 +1508,8 @@ final class _WP_Editors { * Force uncompressed TinyMCE when a custom theme has been defined. * * 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 */ diff --git a/src/wp-includes/class-wp-http-curl.php b/src/wp-includes/class-wp-http-curl.php index 9b201af110..31bc6ae7a0 100644 --- a/src/wp-includes/class-wp-http-curl.php +++ b/src/wp-includes/class-wp-http-curl.php @@ -328,8 +328,8 @@ class WP_Http_Curl { /** * Grabs the headers of the cURL request. * - * Each header is sent individually to this callback, so we append to the `$header` property - * for temporary storage + * Each header is sent individually to this callback, and is appended to the `$header` property + * for temporary storage. * * @since 3.2.0 * @@ -345,14 +345,14 @@ class WP_Http_Curl { /** * Grabs the body of the cURL request. * - * The contents of the document are passed in chunks, so we append to the `$body` + * The contents of the document are passed in chunks, and are appended to the `$body` * property for temporary storage. Returning a length shorter than the length of * `$data` passed in will cause cURL to abort the request with `CURLE_WRITE_ERROR`. * * @since 3.6.0 * - * @param resource $handle cURL handle. - * @param string $data cURL request body. + * @param resource $handle cURL handle. + * @param string $data cURL request body. * @return int Total bytes of data written. */ private function stream_body( $handle, $data ) {