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 #47132 Grouped optional params not grouped correctly.
Submitted: 2009-01-16 23:04 UTC Modified: 2009-11-20 11:31 UTC
From: RQuadling at GMail dot com Assigned: bjori (profile)
Status: Closed Package: Documentation problem
PHP Version: Irrelevant OS: n/a
Private report: No CVE-ID: None
View Developer Edit
Welcome! If you don't have a Git account, you can't do anything here.
If you reported this bug, you can edit this bug over here.
(description)
Block user comment
Status: Assign to:
Package:
Bug Type:
Summary:
From: RQuadling at GMail dot com
New email:
PHP Version: OS:

 

 [2009-01-16 23:04 UTC] RQuadling at GMail dot com 
Description:
------------
phd does not currently support the ability to group optional 
parameters.

number_format (for example) should be rendered ...

string number_format ( float $number [, int $decimals [, string 
$dec_point, string $thousands_sep ]] )

This relates to  [docbook] RFE #1998852: Provide a mechanism to group 
parameters





Expected result:
----------------
string number_format ( float $number [, int $decimals [, string 
$dec_point, string $thousands_sep ]] )

Actual result:
--------------
string number_format ( float $number [, int $decimals [, string 
$dec_point ]], string $thousands_sep )

Patches

Pull Requests

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2009-01-17 11:40 UTC] bjori@php.net 
See also http://markmail.org/message/tmta77d6ypnj7v4e
 [2009-11-20 10:50 UTC] vrana@php.net 
We document these functions as two synopses. It's also more readable.
 [2009-11-20 11:31 UTC] RQuadling at GMail dot com 
Yes (http://svn.php.net/viewvc?view=revision&revision=253220).

DocBook will support the mechanism of grouping optional parameters, so 
it is feasible that DocBook documents will contain this construct and as 
such support within PhD would be nice.

I don't think it is more readable. The syntax of describing a function's 
prototype is well understood. It looks unnecessary.

It was just the lack of support within DocBook and hence PhD that 
hindered this and required the 2 synopses approach.
 
PHP Copyright © 2001-2025 The PHP Group
All rights reserved. 		Last updated: Sun Jul 06 15:01:35 2025 UTC