Package home | Report new bug | New search | Development Roadmap Status: Open | Feedback | All | Closed Since Version 0.9.4

Doc Bug #5403 function argument descriptions inadequate
Submitted: 2005-09-14 19:03 UTC
From: bgold at matrix-consultants dot com Assigned: progi1984
Status: Closed Package: Spreadsheet_Excel_Writer
PHP Version: 4.4.1 OS: Windows
Roadmaps: (Not assigned)    

 [2005-09-14 19:03 UTC] 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?


 [2005-09-30 17:41 UTC] mj
To which package are you referring to, please?
 [2005-09-30 18:57 UTC] 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 21:32 UTC] mj
Sure, if you can allocate some time to review the manual, feel free to open bugs for any mistakes you find.
 [2007-03-27 13:32 UTC] cweiske (Christian Weiske)
Could you please list the methods that you found to be documented inaccurate? I don't have time to look through all of them.
 [2007-03-27 14:55 UTC] bgold at matrix-consultants dot com
I'm not sure if I was looking in the wrong place, or the documentation has been updated. But now I find good documentation for most of the functions. The only exceptions: setMerge/setAlign("merge"): which cells get merged? A couple of examples would be useful. setColor: what is the meaning of the numeric values that are required to be in the range 8-64? For that matter, why that particular range?
 [2007-03-27 15:00 UTC] bgold at matrix-consultants dot com
Oh, and with regard to my comment on 2005-09-30 18:57 UTC, I note that the package has been updated to no longer require COM. So next time I need to build a worksheet I will use Spreadsheet_Excel_Writer instead of the kludge I built last time: write the data and format info into a text file, then parse the text file with a JSP using the jxl package to build the spreadsheet. Spreadsheet_Excel_Writer will be cleaner, I think, and I won't need any intermediate files!
 [2009-08-12 13:42 UTC] progi1984 (Franck Lefevre)
The following patch has been added/updated: Patch Name: setColor Revision: 1250066535 URL:
 [2009-08-12 13:42 UTC] progi1984 (Franck Lefevre)
The following patch has been added/updated: Patch Name: setMerge Revision: 1250066561 URL:
 [2009-08-12 13:45 UTC] progi1984 (Franck Lefevre)
-Type: Bug +Type: Documentation Problem -Assigned To: +Assigned To: progi1984
 [2009-08-12 18:14 UTC] progi1984 (Franck Lefevre)
The following patch has been added/updated: Patch Name: setColor Revision: 1250082853 URL:
 [2009-08-14 16:43 UTC] progi1984 (Franck Lefevre)
The following patch has been added/updated: Patch Name: setColor Revision: 1250250201 URL:
 [2009-08-16 14:06 UTC] cweiske (Christian Weiske)
I applied your setcolor patch after still fixing some CS issues. But setMerge absolutely does not apply - the patch fails really bad. Could you please make the diff against the current svn of setmerge.xml? And the XML ID of the example is wrong - for bgcolor! Original: Patch:
 [2009-10-15 23:12 UTC] cweiske (Christian Weiske)
-Status: Assigned +Status: Closed
This bug has been fixed in SVN. If this was a documentation problem, the fix will appear on by the end of next Sunday (CET). If this was a problem with the website, the change should be live shortly. Otherwise, the fix will appear in the package's next release. Thank you for the report and for helping us make PEAR better. I merged the patch myself to get this going.