#47132 [Csd]: Grouped optional params not grouped correctly.

From: Date: Fri, 20 Nov 2009 11:31:29 +0000
Subject: #47132 [Csd]: Grouped optional params not grouped correctly.
References: 1  Groups: php.doc.bugs 
Request: Send a blank email to doc-bugs+get-3276@lists.php.net to get a copy of this message
ID: 47132 User updated by: RQuadling at GMail dot com Reported By: RQuadling at GMail dot com Status: Closed Bug Type: Documentation problem Operating System: n/a PHP Version: Irrelevant Assigned To: bjori New Comment: 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. Previous Comments: ------------------------------------------------------------------------ [2009-11-20 10:50:59] vrana@php.net We document these functions as two synopses. It's also more readable. ------------------------------------------------------------------------ [2009-01-17 11:40:22] bjori@php.net See also http://markmail.org/message/tmta77d6ypnj7v4e ------------------------------------------------------------------------ [2009-01-16 23:04:25] 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 ) ------------------------------------------------------------------------ -- Edit this bug report at http://bugs.php.net/?id=47132&edit=1

« previous php.doc.bugs (#3276) next »