Changeset 47391 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-autosaves-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-autosaves-controller.php (modified) (4 diffs)

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

@@ -74 +74 @@
 
     /**
-     * Registers routes for autosaves.
+     * Registers the routes for autosaves.
      *
      * @since 5.0.0
@@ -152 +152 @@
      * @since 5.0.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.
      */
@@ -250 +250 @@
      * @since 5.0.0
      *
-     * @param WP_REST_Request $request Full data about the request.
+     * @param WP_REST_Request $request Full details about the request.
      * @return WP_Post|WP_Error Revision post object if ID is valid, WP_Error otherwise.
      */
@@ -285 +285 @@
      * @since 5.0.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.
      */