Doc #54892 [Opn->Wfx]: Confusing optional parameter in fbsql_autocommit()

Edit report at https://bugs.php.net/bug.php?id=54892&edit=1 ID: 54892 Updated by: frozenfire@php.net Reported by: gwarnants at gmail dot com Summary: Confusing optional parameter in fbsql_autocommit() -Status: Open +Status: Wont fix Type: Documentation Problem Package: Documentation problem PHP Version: Irrelevant Block user comment: N Private report: N New Comment: In the manual sources, we use something called language-snippets entities to reduce the number of times we have to copy the same text between multiple reference pages. All of the fbsql functions which have the link_identifier parameter use a language snippet which that produces the parameter description you see. The reason it sounds weird is that some functions have that parameter as optional, while others don't. So what the description is saying is that *when* it's optional, and not specified, it'll do <x>. Otherwise, it'll of course throw an error about a parameter being missing. I don't feel that this possibly-confusing text warrants rewriting all of the parameter descriptions for fbsql functions, so I'm going to set this bug to wont-fix. Previous Comments: ------------------------------------------------------------------------ [2011-06-30 01:04:46] philip@php.net The online documentation editor link relevant to this bug report: https://edit.php.net/?project=PHP&perm=en/function.fbsql-autocommit.php ------------------------------------------------------------------------ [2011-05-20 14:22:21] gwarnants at gmail dot com Description: ------------ --- From manual page: http://www.php.net/function.fbsql-autocommit#Description --- In the function prototype, the first parameter is truly not optional. But in the parameter description, we can read it can be not specified. So either it should be surrounded with brackets in the prototype or there is something wrong in the description. "If optional and not specified, the function will try to find an open link to the FrontBase server" Regards, Geoffray ------------------------------------------------------------------------ -- Edit this bug report at https://bugs.php.net/bug.php?id=54892&edit=1