2009/11/13 Jakub Vrana <[email protected]>:
> vrana                                    Fri, 13 Nov 2009 21:15:08 +0000
>
> Revision: http://svn.php.net/viewvc?view=revision&revision=290700
>
> Log:
> Returns false in error (bug #49801)
>
> Bug: http://bugs.php.net/49801 (Closed) Return value in case of an error is 
> missing
>
> Changed paths:
>    U   phpdoc/en/trunk/reference/filesystem/functions/disk-free-space.xml
>    U   phpdoc/en/trunk/reference/filesystem/functions/disk-total-space.xml
>
> Modified: phpdoc/en/trunk/reference/filesystem/functions/disk-free-space.xml
> ===================================================================
> --- phpdoc/en/trunk/reference/filesystem/functions/disk-free-space.xml  
> 2009-11-13 21:12:18 UTC (rev 290699)
> +++ phpdoc/en/trunk/reference/filesystem/functions/disk-free-space.xml  
> 2009-11-13 21:15:08 UTC (rev 290700)
> @@ -45,7 +45,8 @@
>  <refsect1 role="returnvalues">
>   &reftitle.returnvalues;
>   <para>
> -   Returns the number of available bytes as a float.
> +   Returns the number of available bytes as a float
> +   or &false; in case of an error.
>   </para>
>  </refsect1>
>
>
> Modified: phpdoc/en/trunk/reference/filesystem/functions/disk-total-space.xml
> ===================================================================
> --- phpdoc/en/trunk/reference/filesystem/functions/disk-total-space.xml 
> 2009-11-13 21:12:18 UTC (rev 290699)
> +++ phpdoc/en/trunk/reference/filesystem/functions/disk-total-space.xml 
> 2009-11-13 21:15:08 UTC (rev 290700)
> @@ -37,7 +37,8 @@
>  <refsect1 role="returnvalues">
>   &reftitle.returnvalues;
>   <para>
> -   Returns the total number of bytes as a float.
> +   Returns the total number of bytes as a float
> +   or &false; in case of an error.
>   </para>
>  </refsect1>
>
>
>
> --
> PHP Documentation Commits Mailing List (http://www.php.net/)
> To unsubscribe, visit: http://www.php.net/unsub.php
>

There is an entity for "or &false; on failure"

<!ENTITY return.falseforfailure ' or &false; on failure'>
<!ENTITY return.success 'Returns &true; on success&return.falseforfailure;.'>
<!ENTITY return.void 'No value is returned.'>


I wonder if there should be a standardised text for the "failure"/"error" part?


-- 
-----
Richard Quadling
"Standing on the shoulders of some very clever giants!"
EE : http://www.experts-exchange.com/M_248814.html
Zend Certified Engineer : http://zend.com/zce.php?c=ZEND002498&r=213474731
ZOPA : http://uk.zopa.com/member/RQuadling

Reply via email to