Bug #5403 [NEW]: function argument descriptions inadequate
| From: | bgold at matrix-consultants dot com | Date: | Wed, 14 Sep 2005 19:03:31 +0000 |
| Subject: | Bug #5403 [NEW]: function argument descriptions inadequate | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-6816@lists.php.net to get a copy of this message | ||
From: bgold at matrix-consultants dot com
Operating system: Windows
PHP version: 4.4.1
Package: Documentation
Bug Type: Bug
Bug description: function argument descriptions inadequate
Description:
------------
Many of the functions in this package provide inadequate description of
their arguments.
For example, the worksheet->write() function should tell you to get a
format with workbook->addFormat(). I managed to divine this from the
examples, but precision is nice.
Other functions have worse problems. For example setColor says to use a
string for the color name, but does not provide a list or reference for
valid names. Or to use a numeric value in the range 8-64, without any
specification of what those values mean.
Similarly for setAlign. I'm guessing that "left", "center",
"right" are
allowed, in addition to "merge". If there are any others, they should be
listed. (currency? date/time?)
And how to use "setMerge" (or setAlign("merge")) should be on those pages.
Again, I'm doing guesswork from the examples, but what exactly are the
semantics? Will all cells formatted with the same Format object be
merged? Or all adjacent cells formatted with _any_ Format object that
specifies "merge"? If the latter, is there any way to get two adjacent
sets of merged cells that don't merge together?
--
Edit bug report at http://pear.php.net/bugs/bug.php?id=5403&edit=1
--