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)

History Show all quoted text
  Sat Mar 01 10:45:03 2014 NEILB [...] cpan.org - Ticket created
Subject: module doesn't have an abstract in the pod
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
  Sat Mar 01 11:25:11 2014 gene.boggs [...] gmail.com - Correspondence added
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>
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
  Sat Mar 01 11:25:11 2014 The RT System itself - Status changed from 'new' to 'open'
  Sat Mar 01 11:28:34 2014 gene [...] cpan.org - Status changed from 'open' to 'rejected'
  Sat Mar 01 12:52:23 2014 ether [...] cpan.org - Correspondence added
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!
  Sat Mar 01 13:02:47 2014 gene [...] cpan.org - Correspondence added
Aha. The problem is that this module is missing its =head1 NAME section. Fixing that... -- -gb Epistemologist-at-large
  Sat Mar 01 13:02:47 2014 gene [...] cpan.org - Status changed from 'rejected' to 'open'
  Sat Mar 01 13:12:35 2014 gene [...] cpan.org - Correspondence added
Apologies for my oafish confusion. -- Gene
  Sat Mar 01 13:12:37 2014 gene [...] cpan.org - Status changed from 'open' to 'resolved'