Changeset 47391 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php

Timestamp:

02/28/2020 12:29:53 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for WP_REST_Attachments_Controller.

This adds a missing DocBlock for ::register_routes() and parameter descriptions for ::post_process_item().

Includes minor documenation fixes in other REST API classes for consistency.

Props dkarfa, mukesh27, SergeyBiryukov.
Fixes #48841.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php (modified) (5 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php

@@ -62 +62 @@
 
     /**
-     * Registers routes for revisions based on post types supporting revisions.
+     * Registers the routes for revisions based on post types supporting revisions.
      *
      * @since 4.7.0
@@ -161 +161 @@
      * @since 4.7.0
      *
-     * @param WP_REST_Request $request Full data about the request.
+     * @param WP_REST_Request $request Full details about the request.
      * @return true|WP_Error True if the request has read access, WP_Error object otherwise.
      */
@@ -215 +215 @@
      * @since 4.7.0
      *
-     * @param WP_REST_Request $request Full data about the request.
+     * @param WP_REST_Request $request Full details about the request.
      * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
      */
@@ -364 +364 @@
      * @since 4.7.0
      *
-     * @param WP_REST_Request $request Full data about the request.
+     * @param WP_REST_Request $request Full details about the request.
      * @return bool|WP_Error True if the request has read access for the item, WP_Error object otherwise.
      */
@@ -376 +376 @@
      * @since 4.7.0
      *
-     * @param WP_REST_Request $request Full data about the request.
+     * @param WP_REST_Request $request Full details about the request.
      * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
      */