WordPress.org
Get WordPress

Make WordPress Core

Changeset 55681


Ignore:
Timestamp:
04/24/2023 04:35:17 PM (3 years ago)
Author:
audrasjb
Message:

Docs: Use third-person singular verbs in various function descriptions, as per docblocks standards.

Props laurentmagnin, pouicpouic, jbcouton, audrasjb.
See #57840.

Location:
trunk/src
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-admin/includes/class-wp-privacy-policy-content.php

    r55363 r55681  
    2121
    2222        /**
    23          * Add content to the postbox shown when editing the privacy policy.
     23         * Adds content to the postbox shown when editing the privacy policy.
    2424         *
    2525         * Plugins and themes should suggest text for inclusion in the site's privacy policy.
    … …  
    5050
    5151        /**
    52          * Quick check if any privacy info has changed.
     52         * Performs a quick check to determine whether any privacy info has changed.
    5353         *
    5454         * @since 4.9.6
    … …  
    124124
    125125        /**
    126          * Output a warning when some privacy info has changed.
     126         * Outputs a warning when some privacy info has changed.
    127127         *
    128128         * @since 4.9.6
    … …  
    155155
    156156        /**
    157          * Update the cached policy info when the policy page is updated.
     157         * Updates the cached policy info when the policy page is updated.
    158158         *
    159159         * @since 4.9.6
    … …  
    204204
    205205        /**
    206          * Check for updated, added or removed privacy policy information from plugins.
     206         * Checks for updated, added or removed privacy policy information from plugins.
    207207         *
    208208         * Caches the current info in post_meta of the policy page.
    … …  
    302302
    303303        /**
    304          * Add a notice with a link to the guide when editing the privacy policy page.
     304         * Adds a notice with a link to the guide when editing the privacy policy page.
    305305         *
    306306         * @since 4.9.6
    … …  
    373373
    374374        /**
    375          * Output the privacy policy guide together with content from the theme and plugins.
     375         * Outputs the privacy policy guide together with content from the theme and plugins.
    376376         *
    377377         * @since 4.9.6
    … …  
    442442
    443443        /**
    444          * Return the default suggested privacy policy content.
     444         * Returns the default suggested privacy policy content.
    445445         *
    446446         * @since 4.9.6
    … …  
    691691
    692692        /**
    693          * Add the suggested privacy policy text to the policy postbox.
     693         * Adds the suggested privacy policy text to the policy postbox.
    694694         *
    695695         * @since 4.9.6

  • trunk/src/wp-includes/class-wp-comment.php

    r54133 r55681  
    220220
    221221        /**
    222          * Convert object to array.
     222         * Converts object to array.
    223223         *
    224224         * @since 4.4.0
    … …  
    231231
    232232        /**
    233          * Get the children of a comment.
     233         * Gets the children of a comment.
    234234         *
    235235         * @since 4.4.0
    … …  
    303303
    304304        /**
    305          * Add a child to the comment.
     305         * Adds a child to the comment.
    306306         *
    307307         * Used by `WP_Comment_Query` when bulk-filling descendants.
    … …  
    316316
    317317        /**
    318          * Get a child comment by ID.
     318         * Gets a child comment by ID.
    319319         *
    320320         * @since 4.4.0
    … …  
    332332
    333333        /**
    334          * Set the 'populated_children' flag.
     334         * Sets the 'populated_children' flag.
    335335         *
    336336         * This flag is important for ensuring that calling `get_children()` on a childless comment will not trigger
    … …  
    346346
    347347        /**
    348          * Check whether a non-public property is set.
     348         * Determines whether a non-public property is set.
    349349         *
    350350         * If `$name` matches a post field, the comment post will be loaded and the post's value checked.

  • trunk/src/wp-includes/widgets/class-wp-widget-text.php

    r55553 r55681  
    4545
    4646        /**
    47          * Add hooks for enqueueing assets when registering all widget instances of this widget class.
     47         * Adds hooks for enqueueing assets when registering all widget instances of this widget class.
    4848         *
    4949         * @param int $number Optional. The unique order number of this widget instance
    … …  
    341341
    342342        /**
    343          * Inject max-width and remove height for videos too constrained to fit inside sidebars on frontend.
     343         * Injects max-width and removes height for videos too constrained to fit inside sidebars on frontend.
    344344         *
    345345         * @since 4.9.0
    … …  
    411411
    412412        /**
    413          * Enqueue preview scripts.
     413         * Enqueues preview scripts.
    414414         *
    415415         * These scripts normally are enqueued just-in-time when a playlist shortcode is used.
    … …  
    511511
    512512        /**
    513          * Render form template scripts.
     513         * Renders form template scripts.
    514514         *
    515515         * @since 4.8.0
Note: See TracChangeset for help on using the changeset viewer.