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

Request #10539 Ability to transform doc notes into Documentation bugs
Submitted: 2007-03-28 09:04 UTC Modified: 2007-06-28 00:47 UTC
From: cweiske Assigned: davidc
Status: Closed Package: pearweb (version 1.11.3)
PHP Version: 5.2.1 OS:
Roadmaps: 1.16.0    
Subscription  


 [2007-03-28 09:04 UTC] cweiske (Christian Weiske)
Description: ------------ It would be nice if developers had an option to mark user notes as "to be included in documentation". On the notes managing page should be a third tab where you can see all notes that should be included into documentation.

Comments

 [2007-03-28 09:13 UTC] davidc (David Coallier)
This is defenatly a good idea I find. I'm assigning this to myself for roadmap 1.13.0
 [2007-03-28 19:02 UTC] cellog (Greg Beaver)
I find this to be not a good idea. We have a bug tracker for a reason. Perhaps the text needs to be clearer that the notes are not for reporting bugs?
 [2007-03-28 19:24 UTC] davidc (David Coallier)
This wouldn't be used for reporting bugs, but to help documentation. I would easily see this as a tab called "Useful notes" And then in the packages documentation, a maintainer could flag a note as a usefull note and not as a bug however yes, I have misread and I must admit that it sounds like this would be some kind of misunderstood bug reporting tool. Perhaps we could come to an arrangement about seeing the important notes flagged but in another way notes themselves are the extra documentation and all bad/irrelevant notes will be removed. Let's keep this issue FBK for now, however I want to discuss it with you and christian if we have time. Here if possible, if not then irc
 [2007-03-28 22:17 UTC] cweiske (Christian Weiske)
I do know that we have a bug tracker, and that this here is about notes that should better be in the bug tracker. But you know how people are and that useful notes will end up as a note and not as a bug. Sometimes you don't even know that the note could be added to the documentation, but later on the dev or the documentor decides that this and that example would be good to have in the docs. Maybe a button to create a documentation bug from the note?
 [2007-03-29 09:15 UTC] cellog (Greg Beaver)
Christian, I think you've hit the nail on the head. Christophe Gesche just emailed me with exactly the same suggestion (with the volume of email I'm getting recently I've begun to wonder if people think I'm some kind of SMTP bug tracker :)
 [2007-04-23 22:18 UTC] cellog (Greg Beaver)
to summarize, this should be implemented as follows: A button exists in addition to approve that is "Make into bugs" The form would simply insert directly into the bug database with sdesc "Bug in Documentation: $file" where $file is the manual url and the user note as the ldesc. The package would be "Documentation" and the bug creator the person who clicked the "Make into bugs" button. Finally, emails would be sent out for the bug using the handy-dandy bug email sending function of include/bugs/pear-bug-accountrequest.php sendBugEmail() Then, the note would be marked as deleted. Simple.
 [2007-04-24 00:08 UTC] davidc (David Coallier)
I will have that done by saturday morning Eastern Time :)
 [2007-04-27 22:59 UTC] davidc (David Coallier)
This is pretty much done (and commited), however I need to make sure it's ok, so I am not closing it yet. I'm running some tests tonight.
 [2007-05-10 09:58 UTC] wiesemann (Mark Wiesemann)
David, this feature is already online, but doesn't work, it results in a DB syntax error. Can you please have a look at this?
 [2007-05-17 15:34 UTC] wiesemann (Mark Wiesemann)
David, you might have seen my various fixes to this feature. You might want to add some error checks for the database parts, but after that, this request should be ready to be closed.
 [2007-06-01 21:04 UTC] cellog (Greg Beaver)
enough procrastination already, feature is implemented
 [2007-06-02 15:23 UTC] wiesemann (Mark Wiesemann)
Reopening, the online version still results in "DB Error: syntax error".
 [2007-06-28 00:47 UTC] cweiske (Christian Weiske)
No problems here. I just tried it and it works.