php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login

go to bug id or search bugs for

Doc Bug #54892 Confusing optional parameter in fbsql_autocommit()
Submitted: 2011-05-20 14:22 UTC Modified: 2011-07-02 18:55 UTC
From: gwarnants at gmail dot com Assigned:
Status: Wont fix Package: Documentation problem
PHP Version: Irrelevant OS:
Private report: No CVE-ID: None
View Developer Edit
 [2011-05-20 14:22 UTC] 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

Patches

Pull Requests

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2011-06-30 01:04 UTC] 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-07-02 18:55 UTC] frozenfire@php.net
-Status: Open +Status: Wont fix
 [2011-07-02 18:55 UTC] frozenfire@php.net 
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.
 
PHP Copyright © 2001-2024 The PHP Group
All rights reserved. 		Last updated: Mon Oct 07 00:01:28 2024 UTC