Fix inline documentation for esc_js(). Intended for inline JS only, fixes #11690.

git-svn-id: http://svn.automattic.com/wordpress/trunk@13076 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2010-02-13 02:54:54 +00:00 · 2010-02-13 02:54:54 +00:00 · 53ac3d960e
parent 52f2783331
commit 53ac3d960e
1 changed files with 3 additions and 3 deletions
--- a/wp-includes/formatting.php
+++ b/wp-includes/formatting.php
@ -2300,9 +2300,9 @@ function htmlentities2($myHTML) {
 /**
 * Escape single quotes, htmlspecialchar " < > &, and fix line endings.
 *
- * Escapes text strings for echoing in JS, both inline (for example in onclick="...")
- * and inside <script> tag. Note that the strings have to be in single quotes.
- * The filter 'js_escape' is also applied here.
+ * Escapes text strings for echoing in JS. It is intended to be used for inline JS
+ * (in a tag attribute, for example onclick="..."). Note that the strings have to
+ * be in single quotes. The filter 'js_escape' is also applied here.
 *
 * @since 2.8.0
 *