From:             gokdeniz at cclub dot metu dot edu dot tr
Operating system: 
PHP version:      Irrelevant
PHP Bug Type:     Documentation problem
Bug description:  Examples should include output

Description:
------------
This is not a "problem", but a general issue that can be found in many
pages of php documentation. When an example is given, sometimes it only
shows the function call and not the output. It can be said that many of
these are self-explaining, and it wouldn't be wrong. But a completely
fool-proof documentation, which can be helpful even for a tired developer
in late hours should include outputs for all examples.

Here is only one sample for the issue, and during my experience with php
I've seen many pages giving examples like this. 
http://www.php.net/manual/en/function.realpath.php  shows how to call
realpath function """ $real_path = realpath("../../index.php"); """ Proper
output may be given as 
""" //Assuming your php file resides in /var/www/mysite/dir1/dir2
     echo $real_path
     // outputs
     // /var/www/mysite/index.php


-- 
Edit bug report at http://bugs.php.net/?id=38853&edit=1
-- 
Try a CVS snapshot (PHP 4.4): 
http://bugs.php.net/fix.php?id=38853&r=trysnapshot44
Try a CVS snapshot (PHP 5.2): 
http://bugs.php.net/fix.php?id=38853&r=trysnapshot52
Try a CVS snapshot (PHP 6.0): 
http://bugs.php.net/fix.php?id=38853&r=trysnapshot60
Fixed in CVS:                 http://bugs.php.net/fix.php?id=38853&r=fixedcvs
Fixed in release:             
http://bugs.php.net/fix.php?id=38853&r=alreadyfixed
Need backtrace:               http://bugs.php.net/fix.php?id=38853&r=needtrace
Need Reproduce Script:        http://bugs.php.net/fix.php?id=38853&r=needscript
Try newer version:            http://bugs.php.net/fix.php?id=38853&r=oldversion
Not developer issue:          http://bugs.php.net/fix.php?id=38853&r=support
Expected behavior:            http://bugs.php.net/fix.php?id=38853&r=notwrong
Not enough info:              
http://bugs.php.net/fix.php?id=38853&r=notenoughinfo
Submitted twice:              
http://bugs.php.net/fix.php?id=38853&r=submittedtwice
register_globals:             http://bugs.php.net/fix.php?id=38853&r=globals
PHP 3 support discontinued:   http://bugs.php.net/fix.php?id=38853&r=php3
Daylight Savings:             http://bugs.php.net/fix.php?id=38853&r=dst
IIS Stability:                http://bugs.php.net/fix.php?id=38853&r=isapi
Install GNU Sed:              http://bugs.php.net/fix.php?id=38853&r=gnused
Floating point limitations:   http://bugs.php.net/fix.php?id=38853&r=float
No Zend Extensions:           http://bugs.php.net/fix.php?id=38853&r=nozend
MySQL Configuration Error:    http://bugs.php.net/fix.php?id=38853&r=mysqlcfg

Reply via email to