Skip Menu |

This queue is for tickets about the Text-CSV CPAN distribution.

Report information
The Basics
Id: 90325
Status: resolved
Priority: 0/
Queue: Text-CSV

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

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



Subject: Doc fix for getline_hr and column_names
Great module! Now, the docs for getline_hr() and column_names() suggest, but don't actually say, that calling getline_hr() is mandatory before calling getline_hr_all(), in order to get hashrefs. But this is not the case. This code works perfectly without calling getline_hr(): open(my $io, '<', $path) || die "Can't open($path): $!\n"; $csv -> column_names($csv -> getline($io) ); for my $line (@{$csv -> getline_hr_all($io) }) { ... } close $io; It would be nice to see this section of the docs clarified. TIA.
On Wed Nov 13 00:24:05 2013, RSAVAGE wrote: Show quoted text
> Great module! > > Now, the docs for getline_hr () and column_names () suggest, but don't > actually say, that calling getline_hr () is mandatory before calling > getline_hr_all (), in order to get hashrefs.
Thanks for the report I re-read the docs twice and I don't see where this suggestion is written. So unless I am now looking at new improved docs, that use better wording than what was written when this ticket was issued, please come up with a better wording that we could use in the docs. We are always open to documentation improvements! (Maintainer of Text::CSV_XS)
Subject: Re: [rt.cpan.org #90325] Doc fix for getline_hr and column_names
Date: Thu, 09 Oct 2014 10:32:11 +1100
To: bug-Text-CSV [...] rt.cpan.org
From: Ron Savage <ron [...] savage.net.au>
Hi On 08/10/14 18:16, H.Merijn Brand via RT wrote: Show quoted text
> <URL: https://rt.cpan.org/Ticket/Display.html?id=90325 > > > On Wed Nov 13 00:24:05 2013, RSAVAGE wrote:
>> Great module! >> >> Now, the docs for getline_hr () and column_names () suggest, but don't >> actually say, that calling getline_hr () is mandatory before calling >> getline_hr_all (), in order to get hashrefs.
> > Thanks for the report > > I re-read the docs twice and I don't see where this suggestion is written. > > So unless I am now looking at new improved docs, that use better wording than what was written when this ticket was issued, please come up with a better wording that we could use in the docs.
Good point. Show quoted text
> We are always open to documentation improvements! > (Maintainer of Text::CSV_XS)
In that case, see attached. The diff is longer that expected because my editor - UltraEdit - is configured to remove trailing whitespace when it saves a file. -- Ron Savage - savage.net.au

Message body is not shown because sender requested not to inline it.

Hello! Assuming (from lack of updates to this ticket) that the authors are not very interested in rewording "reference to list" to "arrayref", and considering that the whole "true in case of success" documentation fix is already available in https://rt.cpan.org/Ticket/Display.html?id=78580, I have split this issue into two Github Pull Request: 1) document that getline_hr_all() requires column_names() just like getline_hr () --> https://github.com/makamaka/Text-CSV/pull/23 2) remove trailing whitespace --> https://github.com/makamaka/Text-CSV/pull/24 Hope this helps! Cheers!
On Sun May 31 01:30:57 2015, GARU wrote: Show quoted text
> Hello! Assuming (from lack of updates to this ticket) that the authors > are not very interested in rewording "reference to list" to > "arrayref", and considering that the whole "true in case of success" > documentation fix is already available in > https://rt.cpan.org/Ticket/Display.html?id=78580, I have split this > issue into two Github Pull Request: > > 1) document that getline_hr_all() requires column_names() just like > getline_hr () --> https://github.com/makamaka/Text-CSV/pull/23 > > 2) remove trailing whitespace --> https://github.com/makamaka/Text- > CSV/pull/24 > > Hope this helps! Cheers!
Thanks. Applied both.
On Sun Aug 28 01:14:13 2016, ISHIGAKI wrote: Show quoted text
> On Sun May 31 01:30:57 2015, GARU wrote:
> > Hello! Assuming (from lack of updates to this ticket) that the authors > > are not very interested in rewording "reference to list" to > > "arrayref", and considering that the whole "true in case of success" > > documentation fix is already available in > > https://rt.cpan.org/Ticket/Display.html?id=78580, I have split this > > issue into two Github Pull Request: > > > > 1) document that getline_hr_all() requires column_names() just like > > getline_hr () --> https://github.com/makamaka/Text-CSV/pull/23 > > > > 2) remove trailing whitespace --> https://github.com/makamaka/Text- > > CSV/pull/24 > > > > Hope this helps! Cheers!
> > > Thanks. Applied both.
Closed as 1.91 is out. Thanks.