Bug #5403 [Opn]: function argument descriptions inadequate

Edit report at http://pear.php.net/bugs/bug.php?id=5403&edit=1 ID: 5403 Updated by: mj@php.net Reported By: bgold at matrix-consultants dot com Status: Open Id: 5403 Type: Bug Package: Documentation Operating System: Windows PHP Version: 4.4.1 New Comment: Sure, if you can allocate some time to review the manual, feel free to open bugs for any mistakes you find. Previous Comments: ------------------------------------------------------------------------ [2005-09-30 14:57:40] bgold at matrix-consultants dot com Package Spreadsheet_Excel_Writer, but I recommend reviewing the docs for as many packages as you can spare time for. Or if you need help, I might spend a few evenings just looking for documentation problems. I ran across these problems because I was hoping to use the package to create Excel spreadsheets. But when I started using it, I discovered that it depends on COM. That means I could use it on my (Windows) desktop, but not on the (Linux) server where we deploy our webpages. ------------------------------------------------------------------------ [2005-09-30 13:41:58] mj at php dot net To which package are you referring to, please? ------------------------------------------------------------------------ [2005-09-14 15:03:26] bgold at matrix-consultants dot com 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 this bug report at http://pear.php.net/bugs/bug.php?id=5403&edit=1