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

Bug #10485 Difference between "Notes" and "User comments"
Submitted: 2007-03-25 03:29 UTC Modified: 2007-03-29 22:21 UTC
From: wiesemann Assigned: davidc
Status: Closed Package: pearweb (version 1.11.1)
PHP Version: Irrelevant OS: Irrelevant
Roadmaps: 1.12.0    
Subscription  


 [2007-03-25 03:29 UTC] wiesemann (Mark Wiesemann)
Description: ------------ (There was no response to two emails. Therefore, this is now a bug. It could also have gotten a bug if I had got a reply.) The difference between "Notes" and "User comments" in the new comment system isn't explained anywhere, which makes this new feature a little bit confusing.

Comments

 [2007-03-25 12:12 UTC] davidc (David Coallier)
I consider them the same thing in this case. They can be used to do both *notes* and *user comments*. I mean, a developer can add a note as a user comment and a user can add a user comment as a note. I don't really see how confusing this can get, we could however stick to one word and say "User Notes" instead of "User Notes/Comments" but I don't really see a point in this as this is both notes and comments.
 [2007-03-25 14:30 UTC] wiesemann (Mark Wiesemann)
I guess this is a misunderstanding, maybe on my side. The pages in the manual have now two new "parts": Notes and comments. But I don't see a place where one could enter a comment. Only notes seem to addable (<= does that word exist? *g*). To keep it short: I don't see a place where a *comment* could be added. And I don't see what the difference between a note and a comment should be. Why not only one thing, like it is done in the PHP manual?
 [2007-03-27 09:37 UTC] davidc (David Coallier)
This bug has been fixed in CVS. If this was a documentation problem, the fix will appear on pear.php.net by the end of next Sunday (CET). If this was a problem with the pear.php.net 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 have made it only "add a note"
 [2007-03-27 09:48 UTC] wiesemann (Mark Wiesemann)
The problem still remains: How can one add a comment to a manual page? Why do we need notes *and* comments? To avoid more misunderstandings: At the end of [1], there is a big grey block, starting with a line of "previous" and "next" links, followed by a note (could also be more notes, of course), followed by some links (download, bug report, "add a note") and a date, and finally followed by "User Comments:" (and nothing after this). And when I look at e.g. [2] there is no notes block, but "User Comments:" is now followed by this sentence: "There are no user contributed notes for this page." (*) I guess that it was intented to add only one thing, not two things (notes *and* comments). Therefore, "User comments:" shold be removed, the notes block should always be shown, and if there are no notes, the sentence (*) should be placed here and not at the bottom of the page. Maybe we now talk about the same things ... ;-) [1] http://pear.php.net/manual/en/package.html.html-quickform.html-quickform-date.php [2] http://pear.php.net/manual/en/package.database.mdb2.intro.php
 [2007-03-28 09:29 UTC] davidc (David Coallier)
This bug has been fixed in CVS. If this was a documentation problem, the fix will appear on pear.php.net by the end of next Sunday (CET). If this was a problem with the pear.php.net 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. Ok no more word comment. All is notes now :) Moving on.
 [2007-03-28 10:07 UTC] wiesemann (Mark Wiesemann)
Sorry, but it's still not perfect. ;-) include/pear-manual.php has still "User Comments:" in it, and still at the wrong place. Shouldn't this be place *above* the notes?