#22282 [Opn]: function synopsis for dba_fetch() is wrong

From: Date: Wed, 02 Apr 2003 00:08:11 +0000
Subject: #22282 [Opn]: function synopsis for dba_fetch() is wrong
References: 1  Groups: php.doc 
Request: Send a blank email to phpdoc+get-969352435@lists.php.net to get a copy of this message
ID: 22282 Updated by: alindeman@php.net Reported By: helly@php.net Status: Open Bug Type: Documentation problem Operating System: ANY PHP Version: 4.3.0 New Comment: According to funcsummary.txt in phpdoc/, this is the function layout string dba_fetch(string key, [int skip ,] int handle) Fetches the data associated with key Is this possible to implement in the documentation without making the third param optional? Previous Comments: ------------------------------------------------------------------------ [2003-04-01 17:49:52] philip@php.net See: http://cvs.php.net/cvs.php/phpdoc/en/reference/dba/functions/dba-fetch.xml Hasn't been touched in four months while the manual was last built two months ago, reopening... Although personally I don't understand how a middle parameter can be optional... ------------------------------------------------------------------------ [2003-04-01 17:27:34] alindeman@php.net If it's fixed in the XML file, the documentation probably hasn't updated (there has been some problem with that lately). Should be fixed when documentation starts updating again... ------------------------------------------------------------------------ [2003-02-18 14:25:26] helly@php.net The documentation says both skip and handle parameter are optional, that is wrong. string dba_fetch ( string key [, int skip, resource handle]) Instead only the skip parameter is optional. A look at the xml file snippet below shows it is correct. <methodsynopsis> <type>string</type><methodname>dba_fetch</methodname> <methodparam><type>string</type><parameter>key</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>skip</parameter></methodparam> <methodparam><type>resource</type><parameter>handle</parameter></methodparam> </methodsynopsis> Therefore the documentation should state: string dba_fetch ( string key [, int skip], resource handle) ------------------------------------------------------------------------ -- Edit this bug report at http://bugs.php.net/?id=22282&edit=1

« previous php.doc (#969352435) next »