#38853 [Opn->Csd]: Examples should include output

ID: 38853 Updated by: didou@php.net Reported By: gokdeniz at cclub dot metu dot edu dot tr -Status: Open +Status: Closed Bug Type: Documentation problem PHP Version: Irrelevant New Comment: Hello, We are aware of the need of examples and their output. I just added one for realpath and I'm closing the bug as this item is on our TODO. By the wat, the next manual version will include nice graphics for the GD docs :) Previous Comments: ------------------------------------------------------------------------ [2006-09-16 12:13:37] gokdeniz at cclub dot metu dot edu dot tr 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 this bug report at http://bugs.php.net/?id=38853&edit=1