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

Bug #923 Mail_IMAP examples should not be installed in the Mail dir !
Submitted: 2004-02-28 10:09 UTC
From: bmansion at mamasam dot com Assigned: richy
Status: Closed Package: Mail_IMAP
PHP Version: Irrelevant OS:
Roadmaps: (Not assigned)    
Subscription  


 [2004-02-28 10:09 UTC] bmansion at mamasam dot com
Description: ------------ The examples directory is installed in the Mail directory but must be installed in the docs/ directory. Please try to understand how all this works by looking at another existing package.xml file, QuickForm's package.xml for example. BTW, there is no need to make a new release each time, just replace the last release. I can't remember where this can be done on pear website and have not been able to find it but I know it can be done. Ask the pear-dev list, they will let you know.

Comments

 [2004-02-28 22:47 UTC] richy
(Sorry I forgot I could leave comments on the bug itself) Ok my question is this... if the examples aren't installed in the Mail directory, then how is the user supposed to know where to find the examples? This may be obvious to PEAR developers, but I don't think its obvious to the average user. Especially someone who is new to PEAR. Second, the F.A.Q. at http://pear.php.net/manual/en/developers.packagedef.php shows examples being placed in the same directory as the class file. Look at example 10-2. It doesn't say anything about putting them in a docs directory. Third, if I don't update the version number, how is the user supposed to know that I've fixed or changed anything? (Even if it is something small). Regards, Richard York
 [2004-02-28 23:06 UTC] mansion at php dot net
As I said, look at how it is done for other packages and just do the same. If you define your examples with doc role, they will be installed automatically in the docs/ directory IIRC. Whether or not the users know that the examples are in the docs/ directory is not my business, it is theirs.
 [2004-02-28 23:42 UTC] richy
Honestly I don't *have* to do anything, as far as I'm conserned I've done exactly what has been specified in the F.A.Q. page that I already pointed out. If this is the way that the PEAR Group wants it done, then the package.xml F.A.Q. page should reflect that. Two you *not caring* whether the user knows where your examples are or not seems to defeat the purpose of contributing code in the first place. I want my package to be both understood and used. Its confusing, the documentation doesn't say to do it that way and there's nothing in the docs that says that I can't have it that way, in fact quite the opposite it lays out that I've already got it right. And quite frankly I don't see what it is hurting. Before we continue this discussion you should have a look at the F.A.Q.. regardless of if yours or other packages are doing it differently. To me a role="doc" implies the complete offical documentation including highlighted source code, method explaination, etc.... these are PHP source files, therefore they should be labled role="php". My being new to PEAR, it would be quite helpful if all the little pet-peaves and unspoken standards were all laid out flatly and plainly in the official documentation. And yes, in plain enough terms that an idiot could understand. Because it isn't always that obvious.
 [2004-02-29 22:03 UTC] richy
Thank you for your bug report. This issue has already been fixed in the latest released version of the package, which you can download at http://pear.php.net/packages.php