For Programmers: Free Programming Magazines  


Home > Archive > PHP PEAR Questions and Answers > April 2006 > new bug type "Documentation Bug"









You are viewing an archived Text-only version of the thread. To view this thread in it's original format and/or if you want to reply to this thread please [click here]

 

Author new bug type "Documentation Bug"
Greg Beaver

2006-04-01, 6:59 pm

I wonder if it might be better to have a new bug type to match
Bug/Feature Request called "Documentation Bug" which would display when
looking at open documentation bugs, but would be linked to the package
for which it documents?

I don't get notified of new documentation bugs in things I maintain, and
so I never think about them. If there was an open documentation bug for
the PEAR package, for instance, it would show up every time I look at
open PEAR bugs and I might get annoyed enough to fix it :)

If this sounds interesting, I may cook up a patch for it.

Greg
Lukas Smith

2006-04-01, 6:59 pm

Greg Beaver wrote:
> I wonder if it might be better to have a new bug type to match
> Bug/Feature Request called "Documentation Bug" which would display when
> looking at open documentation bugs, but would be linked to the package
> for which it documents?
>
> I don't get notified of new documentation bugs in things I maintain, and
> so I never think about them. If there was an open documentation bug for
> the PEAR package, for instance, it would show up every time I look at
> open PEAR bugs and I might get annoyed enough to fix it :)
>
> If this sounds interesting, I may cook up a patch for it.


Well my approach was to simply change documentation bugs to package bugs
and only leave documentation bugs as such that are not related to a
specific package.

regards,
Lukas
Greg Beaver

2006-04-01, 6:59 pm

Lukas Smith wrote:

> Greg Beaver wrote:
>
>
>
> Well my approach was to simply change documentation bugs to package
> bugs and only leave documentation bugs as such that are not related to
> a specific package.



Right but you noticed them in the first place because you diligently
follow pear-doc probably :). This way, an email would go out to the
maintainers when the bug is opened. It would be easy to put generic
documentation bugs as simply bugs of the documentation, and put specific
doc bugs as bugs of a package.

Greg
Sponsored Links







Also available: Server administration forum archive | Web Design forum archive | Software forum archive | Hardware reviews archive

Copyright 2008 codecomments.com