Correct the documentation for balanceTags(). props mdawaffe, fixes #19576.

git-svn-id: http://svn.automattic.com/wordpress/trunk@19601 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
nacin 2011-12-16 20:57:05 +00:00
parent 03d21f6606
commit 2ba0d300c4

View File

@ -1012,14 +1012,12 @@ function convert_chars($content, $deprecated = '') {
/**
* Will only balance the tags if forced to and the option is set to balance tags.
*
* The option 'use_balanceTags' is used for whether the tags will be balanced.
* Both the $force parameter and 'use_balanceTags' option will have to be true
* before the tags will be balanced.
* The option 'use_balanceTags' is used to determine whether the tags will be balanced.
*
* @since 0.71
*
* @param string $text Text to be balanced
* @param bool $force Forces balancing, ignoring the value of the option. Default false.
* @param bool $force If true, forces balancing, ignoring the value of the option. Default false.
* @return string Balanced text
*/
function balanceTags( $text, $force = false ) {