<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[30541] trunk/src: Ensure inline code is markdown-escaped as such, HTML tags are removed from summaries, and that code snippets in descriptions are properly indented.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/30541">30541</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/30541","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>DrewAPicture</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2014-11-24 05:38:44 +0000 (Mon, 24 Nov 2014)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 description for `_deprecated_argument()`
* Markdown-indent a code snippet in the description for `wp_localize_script()`
* Backtick-escape HTML tags in two parameter descriptions for `wp_register()`
* Various DocBlock formatting in the description for `get_bloginfo()`
* Remove HTML tag from the summary for `_wp_render_title_tag()`
* Backtick-escape a HTML tag in the description for `get_archives_link()`
* Markdown-indent a code snippet in the description for `wp_admin_css_color()`
* Markdown-indent a code snippet in the description for the `welcome_panel` hook
Props rarst.
See <a href="https://core.trac.wordpress.org/ticket/30473">#30473</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminindexphp">trunk/src/wp-admin/index.php</a></li>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
<li><a href="#trunksrcwpincludesfunctionswpscriptsphp">trunk/src/wp-includes/functions.wp-scripts.php</a></li>
<li><a href="#trunksrcwpincludesgeneraltemplatephp">trunk/src/wp-includes/general-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminindexphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/index.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/index.php 2014-11-24 05:29:43 UTC (rev 30540)
+++ trunk/src/wp-admin/index.php 2014-11-24 05:38:44 UTC (rev 30541)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -111,9 +111,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Add content to the welcome panel on the admin dashboard.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * To remove the default welcome panel, use remove_action():
- * <code>remove_action( 'welcome_panel', 'wp_welcome_panel' );</code>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * To remove the default welcome panel, use {@see remove_action()}:
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * remove_action( 'welcome_panel', 'wp_welcome_panel' );
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 3.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( 'welcome_panel' );
</span></span></pre></div>
<a id="trunksrcwpincludesfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.php 2014-11-24 05:29:43 UTC (rev 30540)
+++ trunk/src/wp-includes/functions.php 2014-11-24 05:38:44 UTC (rev 30541)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3445,12 +3445,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Before this function is called, the argument must be checked for whether it was
</span><span class="cx" style="display: block; padding: 0 10px"> * used by comparing it to its default value or evaluating whether it is empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * For example:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * <code>
- * if ( ! empty( $deprecated ) ) {
- * _deprecated_argument( __FUNCTION__, '3.0' );
- * }
- * </code>
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * if ( ! empty( $deprecated ) ) {
+ * _deprecated_argument( __FUNCTION__, '3.0' );
+ * }
+ *
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * There is a hook deprecated_argument_run that will be called that can be used
</span><span class="cx" style="display: block; padding: 0 10px"> * to get the backtrace up to what file and function used the deprecated
</span><span class="cx" style="display: block; padding: 0 10px"> * argument.
</span></span></pre></div>
<a id="trunksrcwpincludesfunctionswpscriptsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/functions.wp-scripts.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.wp-scripts.php 2014-11-24 05:29:43 UTC (rev 30540)
+++ trunk/src/wp-includes/functions.wp-scripts.php 2014-11-24 05:38:44 UTC (rev 30541)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -90,20 +90,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Works only if the script has already been added.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Accepts an associative array $l10n and creates a JavaScript object:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * <code>
- * "$object_name" = {
- * key: value,
- * key: value,
- * ...
- * }
- * </code>
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * "$object_name" = {
+ * key: value,
+ * key: value,
+ * ...
+ * }
+ *
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @see WP_Dependencies::localize()
</span><span class="cx" style="display: block; padding: 0 10px"> * @link https://core.trac.wordpress.org/ticket/11520
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @todo Documentation cleanup
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $handle Script handle the data will be attached to.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $object_name Name for the JavaScript object. Passed directly, so it should be qualified JS variable.
</span><span class="cx" style="display: block; padding: 0 10px"> * Example: '/[a-zA-Z0-9_]+/'.
</span></span></pre></div>
<a id="trunksrcwpincludesgeneraltemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/general-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/general-template.php 2014-11-24 05:29:43 UTC (rev 30540)
+++ trunk/src/wp-includes/general-template.php 2014-11-24 05:38:44 UTC (rev 30541)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -511,8 +511,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $before Text to output before the link (defaults to <li>).
- * @param string $after Text to output after the link (defaults to </li>).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $before Text to output before the link. Default `<li>`.
+ * @param string $after Text to output after the link. Default `</li>`.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param boolean $echo Default to echo and not return the link.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string|null String when retrieving, null when displaying.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -581,16 +581,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieve information about the blog.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Some show parameter values are deprecated and will be removed in future
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * versions. These options will trigger the _deprecated_argument() function.
- * The deprecated blog info options are listed in the function contents.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * versions. These options will trigger the {@see _deprecated_argument()}
+ * function. The deprecated blog info options are listed in the function
+ * contents.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The possible values for the 'show' parameter are listed below.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * <ol>
- * <li><strong>url</strong> - Blog URI to homepage.</li>
- * <li><strong>wpurl</strong> - Blog URI path to WordPress.</li>
- * <li><strong>description</strong> - Secondary title</li>
- * </ol>
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 1. url - Blog URI to homepage.
+ * 2. wpurl - Blog URI path to WordPress.
+ * 3. description - Secondary title
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * The feed URL options can be retrieved from 'rdf_url' (RSS 0.91),
</span><span class="cx" style="display: block; padding: 0 10px"> * 'rss_url' (RSS 1.0), 'rss2_url' (RSS 2.0), or 'atom_url' (Atom feed). The
</span><span class="cx" style="display: block; padding: 0 10px"> * comment feeds can be retrieved from the 'comments_atom_url' (Atom comment
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -714,7 +714,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Display <title> tag with contents.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Display title tag with contents.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1233,7 +1233,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * elements). Custom content is also supported using the before and after
</span><span class="cx" style="display: block; padding: 0 10px"> * parameters.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The 'link' format uses the link HTML element with the <em>archives</em>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The 'link' format uses the `<link>` HTML element with the **archives**
</ins><span class="cx" style="display: block; padding: 0 10px"> * relationship. The before and after parameters are not used. The text
</span><span class="cx" style="display: block; padding: 0 10px"> * parameter is used to describe the link.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1251,6 +1251,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @todo Properly document optional arguments as such
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $url URL to archive.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $text Archive text description.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $format Optional, default is 'html'. Can be 'link', 'option', 'html', or custom.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2706,13 +2708,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Registers an admin colour scheme css file.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Allows a plugin to register a new admin colour scheme. For example:
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * <code>
- * wp_admin_css_color('classic', __('Classic'), admin_url("css/colors-classic.css"),
- * array('#07273E', '#14568A', '#D54E21', '#2683AE'));
- * </code>
</del><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * wp_admin_css_color( 'classic', __( 'Classic' ), admin_url( "css/colors-classic.css" ), array(
+ * '#07273E', '#14568A', '#D54E21', '#2683AE'
+ * ) );
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @todo Properly document optional arguments as such
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $key The unique key for this theme.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $name The name of the theme.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $url The url of the css file containing the colour scheme.
</span></span></pre>
</div>
</div>
</body>
</html>