Skip Menu |

This queue is for tickets about the Module-Install-Bugtracker CPAN distribution.

Report information
The Basics
Id: 70912
Status: resolved
Priority: 0/
Queue: Module-Install-Bugtracker

People
Owner: Nobody in particular
Requestors: florent.angly [...] gmail.com
Cc:
AdminCc:

Bug Information
Severity: (no value)
Broken in: 0.02
Fixed in: (no value)



Subject: Documentation unclear and POD parsing
Hi Marcel, Thanks for the module! I think howerver that the documentation is unsufficient for people to understand what the module does, and if they should use it. From reading the source, I gather that M::I::Bugtracker is only for CPAN modules and that it will include the URL of the CPAN bugtracker. The URL created would be invalid for packages that are not hosted on CPAN, or that use a bugtracker elsewhere. That should probably clarified in the POD. But since M::I::Bugtracker has such a generic name, it would be nice if it would read a module's or script's POD to find if the bugtracker is specified there! Cheers, Florent
Thanks for the bug report. Here's the new documentation, starting in versions > .02: NAME Module::Install::Bugtracker - A Module::Install extension that automatically sets the CPAN bugtracker URL DESCRIPTION This is a plugin for Module::Install to automatically set the bugtracker URL via "bugtracker()" which will then be added to resources under *META.yml*. At present this module only support CPAN bug trackers, resulting in links such as https://rt.cpan.org/Dist/Display.html?Name=Module-Install-Bugtracker I've also noted a TODO in the documentation to expand the module to provide support for other bug trackers. Closing. Feel free to reopen if you feel more work needs to be done. If you'd rather leave it open until support for other bugtrackers is provided, I suggest opening a new RFE with details. Regards, David On Tue Sep 13 01:20:49 2011, FANGLY wrote: Show quoted text
> Hi Marcel, > > Thanks for the module! I think howerver that the documentation is > unsufficient for people to understand what the module does, and if they > should use it. From reading the source, I gather that M::I::Bugtracker > is only for CPAN modules and that it will include the URL of the CPAN > bugtracker. The URL created would be invalid for packages that are not > hosted on CPAN, or that use a bugtracker elsewhere. That should probably > clarified in the POD. > > But since M::I::Bugtracker has such a generic name, it would be nice if > it would read a module's or script's POD to find if the bugtracker is > specified there! > > Cheers, > > Florent