Skip Menu |

This queue is for tickets about the Constant-Generate CPAN distribution.

Report information
The Basics
Id: 74235
Status: resolved
Priority: 0/
Queue: Constant-Generate

People
Owner: Nobody in particular
Requestors: NEILB [...] cpan.org
Cc:
AdminCc:

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



Subject: documentation pedantry
The pod uses three different terms to refer to the bit flags type of constant: bitflags: e.g. in the SYNOPSIS bits: also in the SYNOPSIS bitfield: in the DESCRIPTION section I realise that the code just looks for /bit/i, and the doc even points this out, but I think consistency in the doc would reduce the likelihood of confusion. Also, you have a minor pod error: C<type => 'bitfield'> Which should be: C<type =E<gt> 'bitfield'>
Fixed in 0.15 On Sun Jan 22 06:30:31 2012, NEILB wrote: Show quoted text
> The pod uses three different terms to refer to the bit flags type of > constant: > > bitflags: e.g. in the SYNOPSIS > bits: also in the SYNOPSIS > bitfield: in the DESCRIPTION section > > I realise that the code just looks for /bit/i, and the doc even points > this out, but I think > consistency in the doc would reduce the likelihood of confusion. > > Also, you have a minor pod error: > > C<type => 'bitfield'> > > Which should be: > > C<type =E<gt> 'bitfield'> >
err.. and resolved. poof!