Changeset 53314

Timestamp:

04/29/2022 02:44:15 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Adjust comments in Gruntfile.js per the documentation standards.

See #54729.

File:

• trunk/Gruntfile.js (modified) (5 diffs)

trunk/Gruntfile.js

@@ -517 +517 @@
                     'wp-includes/css/*.css',
 
-                    // Exclude minified and already processed files, and files from external packages.
-                    // These are present when running `grunt build` after `grunt --dev`.
+                    /*
+                     * Exclude minified and already processed files, and files from external packages.
+                     * These are present when running `grunt build` after `grunt --dev`.
+                     */
                     '!wp-admin/css/*-rtl.css',
                     '!wp-includes/css/*-rtl.css',
@@ -1219 +1221 @@
     grunt.registerTask( 'sync-gutenberg-packages', function() {
         if ( grunt.option( 'update-browserlist' ) ) {
-            // Updating the browserlist database is opt-in and up to the release lead.
-            //
-            // Browserlist database should be updated:
-            // * In each release cycle up until RC1
-            // * If Webpack throws a warning about an outdated database
-            //
-            // It should not be updated:
-            // * After the RC1
-            // * When backporting fixes to older WordPress releases.
-            //
-            // For more context, see:
-            // https://github.com/WordPress/wordpress-develop/pull/2621#discussion_r859840515
-            // https://core.trac.wordpress.org/ticket/55559
+            /*
+             * Updating the browserlist database is opt-in and up to the release lead.
+             *
+             * Browserlist database should be updated:
+             * - In each release cycle up until RC1
+             * - If Webpack throws a warning about an outdated database
+             *
+             * It should not be updated:
+             * - After the RC1
+             * - When backporting fixes to older WordPress releases.
+             *
+             * For more context, see:
+             * https://github.com/WordPress/wordpress-develop/pull/2621#discussion_r859840515
+             * https://core.trac.wordpress.org/ticket/55559
+             */
             grunt.task.run( 'browserslist:update' );
         }
@@ -1238 +1242 @@
         grunt.task.run( 'wp-packages:update' );
 
-        // Install any new @wordpress packages that are now required.
-        // Update any non-@wordpress deps to the same version as required in the @wordpress packages (e.g. react 16 -> 17).
+        /*
+         * Install any new @wordpress packages that are now required.
+         * Update any non-@wordpress deps to the same version as required in the @wordpress packages (e.g. react 16 -> 17).
+         */
         grunt.task.run( 'wp-packages:refresh-deps' );
 
@@ -1518 +1524 @@
 
         const files = match[1].split( '\n\t' ).filter( function( file ) {
-            // Filter out empty lines
+            // Filter out empty lines.
             if ( '' === file ) {
                 return false;
             }
 
-            // Filter out commented out lines
+            // Filter out commented out lines.
             if ( 0 === file.indexOf( '/' ) ) {
                 return false;
@@ -1530 +1536 @@
             return true;
         } ).map( function( file ) {
-            // Strip leading and trailing single quotes and commas
+            // Strip leading and trailing single quotes and commas.
             return file.replace( /^\'|\',$/g, '' );
         } );