Skip Menu |

This queue is for tickets about the File-XDG CPAN distribution.

Report information
The Basics
Id: 84730
Status: resolved
Priority: 0/
Queue: File-XDG

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

Bug Information
Severity: Normal
Broken in: 0.03
Fixed in: 0.04



Subject: A careless documentation error
The new() subroutine takes the hash format args File::XDG->new( name => 'appfoo' ); I know this because I had to look at the source - for a module this simple :-(. The SYNOPSIS documentation says: use File::XDG; my $xdg = File::XDG->new('foo'); Has to be instead: my $xdg = File::XDG->new( name => 'foo'); The result is use File::XDG; my $xdg = File::XDG->new('foo'); Has to be instead: my $xdg = File::XDG->new( name => 'foo'); Results of using documented code are: Odd number of elements in hash assignment at /usr/local/share/perl/5.14.2/File/XDG.pm line 71 I do not submit patches for mistakes this careless and trivial. Cheers.
Subject: A careless bug report
Le 2013-04-19 07:47:28, Perlsomian a écrit : Show quoted text
> The new() subroutine takes the hash format args > > File::XDG->new( name => 'appfoo' ); > > I know this because I had to look at the source - for a module this > simple :-(.
This seems to be already documented correctly in the CONSTRUCTOR section. Show quoted text
> The SYNOPSIS documentation says: > > use File::XDG; > my $xdg = File::XDG->new('foo'); > > Has to be instead: > > my $xdg = File::XDG->new( name => 'foo');
OK, this is the real issue. -- Olivier Mengué - http://perlresume.org/DOLMEN
I've noticed this is fixed in the git repo, so this is a small nudge that a new release would be amazing. :) ~ pjf
Thanks for the nudging, 0.04's been released.