Make WordPress Core

Changeset 55646


Ignore:
Timestamp:
04/11/2023 10:04:58 PM (12 months 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:

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.

Location:
trunk/src/wp-includes
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-editor.php

    r55398 r55646  
    15091509     *
    15101510     * The compressed TinyMCE file cannot deal with custom themes, so this makes
    1511      * sure that we use the uncompressed TinyMCE file if a theme is defined.
    1512      * Even if we are on a production environment.
     1511     * sure that WordPress uses the uncompressed TinyMCE file if a theme is defined.
     1512     * Even if the website is running on a production environment.
    15131513     *
    15141514     * @since 5.0.0
  • trunk/src/wp-includes/class-wp-http-curl.php

    r54133 r55646  
    329329     * Grabs the headers of the cURL request.
    330330     *
    331      * Each header is sent individually to this callback, so we append to the `$header` property
    332      * for temporary storage
     331     * Each header is sent individually to this callback, and is appended to the `$header` property
     332     * for temporary storage.
    333333     *
    334334     * @since 3.2.0
     
    346346     * Grabs the body of the cURL request.
    347347     *
    348      * The contents of the document are passed in chunks, so we append to the `$body`
     348     * The contents of the document are passed in chunks, and are appended to the `$body`
    349349     * property for temporary storage. Returning a length shorter than the length of
    350350     * `$data` passed in will cause cURL to abort the request with `CURLE_WRITE_ERROR`.
     
    352352     * @since 3.6.0
    353353     *
    354      * @param resource $handle  cURL handle.
    355      * @param string   $data    cURL request body.
     354     * @param resource $handle cURL handle.
     355     * @param string   $data   cURL request body.
    356356     * @return int Total bytes of data written.
    357357     */
Note: See TracChangeset for help on using the changeset viewer.