svn: /phpdoc/en/trunk/reference/var/functions/ print-r.xml

salathe Wed, 13 Jan 2010 09:20:38 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=293493 Log: Clarify use of return parameter. Fixes #50730 Bug: http://bugs.php.net/50730 (Bogus) suggest changing which is does by default--ambiguous Changed paths: U phpdoc/en/trunk/reference/var/functions/print-r.xml Modified: phpdoc/en/trunk/reference/var/functions/print-r.xml =================================================================== --- phpdoc/en/trunk/reference/var/functions/print-r.xml 2010-01-13 07:32:45 UTC (rev 293492) +++ phpdoc/en/trunk/reference/var/functions/print-r.xml 2010-01-13 09:20:38 UTC (rev 293493) @@ -49,9 +49,8 @@ <listitem> <para> If you would like to capture the output of <function>print_r</function>, - use the <parameter>return</parameter> parameter. If this parameter is set - to &true;, <function>print_r</function> will return its output, instead of - printing it (which it does by default). + use the <parameter>return</parameter> parameter. When this parameter is set + to &true;, <function>print_r</function> will return the information rather than print it. </para> </listitem> </varlistentry> @@ -67,6 +66,10 @@ will be presented in a format that shows keys and elements. Similar notation is used for <type>object</type>s. </para> + <para> + When the <parameter>return</parameter> parameter is &true;, this function + will return a <type>string</type>. Otherwise, the return value is &true;. + </para> </refsect1> <refsect1 role="notes">