Changeset 30542 for trunk/src/wp-admin/install-helper.php

Timestamp:

11/24/2014 05:46:04 AM (10 years ago)

Author:

DrewAPicture

Message:

Ensure inline code is markdown-escaped as such, HTML tags are removed from summaries, and that code snippets in descriptions are properly indented.

Affects DocBlocks for the following core elements:

• Markdown-indent a code snippet in the file header for wp-admin/install-helper.php
• Add markdown formatting and two inline @see tags to the description for translate()
• Markdown-indent a code snippet in the description for _n_noop()
• Remove HTML tags from the summary for get_media_embedded_in_content()
• Remove an HTML tag from the summary for wpview_media_sandbox_styles()

Props rarst.
See #30473.

File:

• trunk/src/wp-admin/install-helper.php (modified) (1 diff)

trunk/src/wp-admin/install-helper.php

@@ -11 +11 @@
  * do, then it is advised to just write the SQL code yourself.
  *
- * <code>
- * check_column('wp_links', 'link_description', 'mediumtext');
- * if (check_column($wpdb->comments, 'comment_author', 'tinytext'))
- *     echo "ok\n";
+ *     check_column( 'wp_links', 'link_description', 'mediumtext' );
+ *     if ( check_column( $wpdb->comments, 'comment_author', 'tinytext' ) ) {
+ *         echo "ok\n";
+ *     }
  *
- * $error_count = 0;
- * $tablename = $wpdb->links;
- * // check the column
- * if (!check_column($wpdb->links, 'link_description', 'varchar(255)')) {
- *     $ddl = "ALTER TABLE $wpdb->links MODIFY COLUMN link_description varchar(255) NOT NULL DEFAULT '' ";
- *     $q = $wpdb->query($ddl);
- * }
+ *     $error_count = 0;
+ *     $tablename = $wpdb->links;
+ *     // Check the column.
+ *     if ( ! check_column($wpdb->links, 'link_description', 'varchar( 255 )' ) ) {
+ *         $ddl = "ALTER TABLE $wpdb->links MODIFY COLUMN link_description varchar(255) NOT NULL DEFAULT '' ";
+ *         $q = $wpdb->query( $ddl );
+ *     }
  *
- * if (check_column($wpdb->links, 'link_description', 'varchar(255)')) {
- *     $res .= $tablename . ' - ok <br />';
- * } else {
- *     $res .= 'There was a problem with ' . $tablename . '<br />';
- *     ++$error_count;
- * }
- * </code>
+ *     if ( check_column( $wpdb->links, 'link_description', 'varchar( 255 )' ) ) {
+ *         $res .= $tablename . ' - ok <br />';
+ *     } else {
+ *         $res .= 'There was a problem with ' . $tablename . '<br />';
+ *         ++$error_count;
+ *     }
  *
  * @package WordPress