PHP Bugs: #47132: Grouped optional params not grouped correctly.

Bug #47132	Grouped optional params not grouped correctly.
Submitted:	16 Jan 11:04pm UTC	Modified:	20 Nov 11:31am UTC
From:	RQuadling at GMail dot com	Assigned to:	bjori
Status:	Closed	Category:	Documentation problem
Version:	Irrelevant	OS:	n/a

View/Vote Developer Edit Submission

[16 Jan 11:04pm 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 )

[17 Jan 11:40am UTC] bjori@php.net

See also http://markmail.org/message/tmta77d6ypnj7v4e

[20 Nov 10:50am UTC] vrana@php.net

We document these functions as two synopses. It's also more readable.

[20 Nov 11:31am 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.net \| support \| documentation \| report a bug \| advanced search \| search howto \| statistics \| login

go to bug id or search bugs for