Changeset 47122 for trunk/src/wp-admin/includes/schema.php

Timestamp:

01/29/2020 12:43:23 AM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

• trunk/src/wp-admin/includes/schema.php (modified) (13 diffs)

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

@@ -53 +53 @@
     $max_index_length = 191;
 
-    // Blog specific tables.
+    // Blog-specific tables.
     $blog_tables = "CREATE TABLE $wpdb->termmeta (
     meta_id bigint(20) unsigned NOT NULL auto_increment,
@@ -206 +206 @@
 ) $charset_collate;\n";
 
-    // Multisite users table
+    // Multisite users table.
     $users_multi_table = "CREATE TABLE $wpdb->users (
     ID bigint(20) unsigned NOT NULL auto_increment,
@@ -237 +237 @@
 ) $charset_collate;\n";
 
-    // Global tables
+    // Global tables.
     if ( $is_multisite ) {
         $global_tables = $users_multi_table . $usermeta_table;
@@ -548 +548 @@
     }
 
-    // 3.0 multisite
+    // 3.0 multisite.
     if ( is_multisite() ) {
         /* translators: %s: Network title. */
@@ -557 +557 @@
     $options = wp_parse_args( $options, $defaults );
 
-    // Set autoload to no for these options
+    // Set autoload to no for these options.
     $fat_options = array( 'moderation_keys', 'recently_edited', 'blacklist_keys', 'uninstall_plugins' );
 
@@ -678 +678 @@
     $wpdb->query( "DELETE FROM $wpdb->options WHERE option_name REGEXP '^rss_[0-9a-f]{32}(_ts)?$'" );
 
-    // Clear expired transients
+    // Clear expired transients.
     delete_expired_transients( true );
 }
@@ -704 +704 @@
  */
 function populate_roles_160() {
-    // Add roles
-
+    // Add roles.
     add_role( 'administrator', 'Administrator' );
     add_role( 'editor', 'Editor' );
@@ -712 +711 @@
     add_role( 'subscriber', 'Subscriber' );
 
-    // Add caps for Administrator role
+    // Add caps for Administrator role.
     $role = get_role( 'administrator' );
     $role->add_cap( 'switch_themes' );
@@ -745 +744 @@
     $role->add_cap( 'level_0' );
 
-    // Add caps for Editor role
+    // Add caps for Editor role.
     $role = get_role( 'editor' );
     $role->add_cap( 'moderate_comments' );
@@ -767 +766 @@
     $role->add_cap( 'level_0' );
 
-    // Add caps for Author role
+    // Add caps for Author role.
     $role = get_role( 'author' );
     $role->add_cap( 'upload_files' );
@@ -778 +777 @@
     $role->add_cap( 'level_0' );
 
-    // Add caps for Contributor role
+    // Add caps for Contributor role.
     $role = get_role( 'contributor' );
     $role->add_cap( 'edit_posts' );
@@ -785 +784 @@
     $role->add_cap( 'level_0' );
 
-    // Add caps for Subscriber role
+    // Add caps for Subscriber role.
     $role = get_role( 'subscriber' );
     $role->add_cap( 'read' );
@@ -1245 +1244 @@
         /* translators: %s: Site link. */
         'first_post'                  => __( 'Welcome to %s. This is your first post. Edit or delete it, then start writing!' ),
-        // @todo - network admins should have a method of editing the network siteurl (used for cookie hash)
+        // @todo - Network admins should have a method of editing the network siteurl (used for cookie hash).
         'siteurl'                     => get_option( 'siteurl' ) . '/',
         'add_new_users'               => '0',