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: - [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. Built from https://develop.svn.wordpress.org/trunk@55646 git-svn-id: http://core.svn.wordpress.org/trunk@55158 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
parent
968156d9ee
commit
d85d579ba1
|
@ -1508,8 +1508,8 @@ final class _WP_Editors {
|
||||||
* Force uncompressed TinyMCE when a custom theme has been defined.
|
* Force uncompressed TinyMCE when a custom theme has been defined.
|
||||||
*
|
*
|
||||||
* The compressed TinyMCE file cannot deal with custom themes, so this makes
|
* 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.
|
* sure that WordPress uses the uncompressed TinyMCE file if a theme is defined.
|
||||||
* Even if we are on a production environment.
|
* Even if the website is running on a production environment.
|
||||||
*
|
*
|
||||||
* @since 5.0.0
|
* @since 5.0.0
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -328,8 +328,8 @@ class WP_Http_Curl {
|
||||||
/**
|
/**
|
||||||
* Grabs the headers of the cURL request.
|
* Grabs the headers of the cURL request.
|
||||||
*
|
*
|
||||||
* Each header is sent individually to this callback, so we append to the `$header` property
|
* Each header is sent individually to this callback, and is appended to the `$header` property
|
||||||
* for temporary storage
|
* for temporary storage.
|
||||||
*
|
*
|
||||||
* @since 3.2.0
|
* @since 3.2.0
|
||||||
*
|
*
|
||||||
|
@ -345,14 +345,14 @@ class WP_Http_Curl {
|
||||||
/**
|
/**
|
||||||
* Grabs the body of the cURL request.
|
* 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
|
* 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`.
|
* `$data` passed in will cause cURL to abort the request with `CURLE_WRITE_ERROR`.
|
||||||
*
|
*
|
||||||
* @since 3.6.0
|
* @since 3.6.0
|
||||||
*
|
*
|
||||||
* @param resource $handle cURL handle.
|
* @param resource $handle cURL handle.
|
||||||
* @param string $data cURL request body.
|
* @param string $data cURL request body.
|
||||||
* @return int Total bytes of data written.
|
* @return int Total bytes of data written.
|
||||||
*/
|
*/
|
||||||
private function stream_body( $handle, $data ) {
|
private function stream_body( $handle, $data ) {
|
||||||
|
|
|
@ -16,7 +16,7 @@
|
||||||
*
|
*
|
||||||
* @global string $wp_version
|
* @global string $wp_version
|
||||||
*/
|
*/
|
||||||
$wp_version = '6.3-alpha-55645';
|
$wp_version = '6.3-alpha-55646';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||||
|
|
Loading…
Reference in New Issue