Changeset 52242

Timestamp:

11/24/2021 11:58:20 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Miscellaneous DocBlock corrections.

See #53399.

Location:

trunk

Files:

• src/js/media/views/modal.js (modified) (1 diff)
• src/wp-admin/includes/file.php (modified) (1 diff)
• src/wp-includes/rest-api.php (modified) (3 diffs)
• tests/phpunit/includes/mock-invokable.php (modified) (1 diff)
• tests/phpunit/includes/spy-rest-server.php (modified) (2 diffs)
• tests/phpunit/tests/admin/includesFile.php (modified) (2 diffs)

trunk/src/js/media/views/modal.js

@@ -139 +139 @@
         $( 'body' ).removeClass( 'modal-open' );
 
-        // Hide the modal element by adding display none.
+        // Hide the modal element by adding display:none.
         this.$el.hide();
 

trunk/src/wp-admin/includes/file.php

@@ -1195 +1195 @@
         }
 
-        // Potential file name must be valid string
-        if ( $tmpfname_disposition && is_string( $tmpfname_disposition ) && ( 0 === validate_file( $tmpfname_disposition ) ) ) {
+        // Potential file name must be valid string.
+        if ( $tmpfname_disposition && is_string( $tmpfname_disposition )
+            && ( 0 === validate_file( $tmpfname_disposition ) )
+        ) {
             if ( rename( $tmpfname, $tmpfname_disposition ) ) {
                 $tmpfname = $tmpfname_disposition;

trunk/src/wp-includes/rest-api.php

@@ -3057 +3057 @@
  *
  * @param int|WP_Post $post Post ID or post object.
- * @return string The route path with a leading slash for the given post, or an empty string if there is not a route.
+ * @return string The route path with a leading slash for the given post,
+ *                or an empty string if there is not a route.
  */
 function rest_get_route_for_post( $post ) {
@@ -3090 +3091 @@
  *
  * @param string $post_type The name of a registered post type.
- * @return string The route path with a leading slash for the given post type, or an empty string if there is not a route.
+ * @return string The route path with a leading slash for the given post type,
+ *                or an empty string if there is not a route.
  */
 function rest_get_route_for_post_type_items( $post_type ) {
@@ -3123 +3125 @@
  *
  * @param int|WP_Term $term Term ID or term object.
- * @return string The route path with a leading slash for the given term, or an empty string if there is not a route.
+ * @return string The route path with a leading slash for the given term,
+ *                or an empty string if there is not a route.
  */
 function rest_get_route_for_term( $term ) {

trunk/tests/phpunit/includes/mock-invokable.php

@@ -10 +10 @@
  * Class Mock_Invokable.
  *
- * This class is using to mock a class that has __invoke method.
+ * This class is used to mock a class that has an `__invoke` method.
  */
 class Mock_Invokable {

trunk/tests/phpunit/includes/spy-rest-server.php

@@ -40 +40 @@
 
     /**
-     * Stores last set status.
-     * @param int $code HTTP status.
-     */
-    public function set_status( $status ) {
-        $this->status = $status;
-    }
-
-    /**
      * Removes a header from the list of sent headers.
      *
@@ -54 +46 @@
     public function remove_header( $header ) {
         unset( $this->sent_headers[ $header ] );
+    }
+
+    /**
+     * Stores last set status.
+     *
+     * @param int $code HTTP status.
+     */
+    public function set_status( $status ) {
+        $this->status = $status;
     }
 

trunk/tests/phpunit/tests/admin/includesFile.php

@@ -89 +89 @@
      * @covers ::download_url
      *
-     * @param $filter  A callback containing a fake Content-Disposition header.
+     * @param $filter A callback containing a fake Content-Disposition header.
      */
     public function test_download_url_should_respect_filename_from_content_disposition_header( $filter ) {
@@ -175 +175 @@
      * @covers ::download_url
      *
-     * @param $filter  A callback containing a fake Content-Disposition header.
+     * @param $filter A callback containing a fake Content-Disposition header.
      */
     public function test_download_url_should_reject_filename_from_invalid_content_disposition_header( $filter ) {