Skip Menu |
 

This queue is for tickets about the SVG-Graph-Kit CPAN distribution.

Report information
The Basics
Id: 93456
Status: resolved
Priority: 0/
Queue: SVG-Graph-Kit

People
Owner: gene [...] cpan.org
Requestors: NEILB [...] cpan.org
Cc:
AdminCc:

Bug Information
Severity: Normal
Broken in: 0.04
Fixed in: (no value)



Subject: module doesn't have an abstract in the pod
Download (untitled) / with headers
text/plain 345b
Hi Gene, Your module doesn't have an abstract in the pod: =head1 NAME SVG::Graph::Kit - simplified data plotting with SVG As a result various tools, including MetaCPAN, don't present your module right. I notice you're using Dist::Zilla, so you could either use the appropriate plugin, or put the abstract in manually. Cheers, Neil
Subject: Re: [rt.cpan.org #93456] module doesn't have an abstract in the pod
Date: Sat, 01 Mar 2014 11:24:53 -0500
To: bug-SVG-Graph-Kit [...] rt.cpan.org
From: Gene Boggs <gene.boggs [...] gmail.com>
Download (untitled) / with headers
text/plain 700b
The module ABSTRACT is already in the code, right under the package declaration. # ABSTRACT: Simplified data plotting with SVG I have never heard of duplicating the ABSTRACT in the actual documentation. Regards, Gene Boggs, Software engineering|Web development|Data science On 2014.03.01 10:45:04 , Neil_Bowers via RT wrote: Show quoted text
> Hi Gene, > > Your module doesn't have an abstract in the pod: > > =head1 NAME > > SVG::Graph::Kit - simplified data plotting with SVG > > As a result various tools, including MetaCPAN, don't present your module right. > > I notice you're using Dist::Zilla, so you could either use the appropriate plugin, or put the abstract in manually. > > Cheers, > Neil
Download (untitled) / with headers
text/plain 666b
On 2014-03-01 08:25:11, gene.boggs@gmail.com wrote: Show quoted text
> The module ABSTRACT is already in the code, right under the package > declaration. > > # ABSTRACT: Simplified data plotting with SVG > > I have never heard of duplicating the ABSTRACT in the actual > documentation.
If you've copied that convention from other modules, you should also be aware that those modules use automated tools to copy that string from the code comment into pod (generally via Pod::Weaver). The end goal is actually to get it into a =head1 NAME section of pod, so search.cpan.org and metacpan.org can use that string to describe the module in search results. Take a look around and see!
Download (untitled) / with headers
text/plain 120b
Aha. The problem is that this module is missing its =head1 NAME section. Fixing that... -- -gb Epistemologist-at-large
Apologies for my oafish confusion. -- Gene


This service is sponsored and maintained by Best Practical Solutions and runs on Perl.org infrastructure.

Please report any issues with rt.cpan.org to rt-cpan-admin@bestpractical.com.