Bug #131414 for Term-ANSIColor: Example for uncolor() does not work as documented.

Fri Jan 10 03:16:59 2020 joeinwap [...] gmail.com - Ticket created

Subject:	Example for uncolor() does not work as documented.
Date:	Fri, 10 Jan 2020 00:16:42 -0800
To:	bug-Term-ANSIColor [...] rt.cpan.org
From:	Joe Smith <joeinwap [...] gmail.com>

This example does not work: # Map escape sequences back to color names. use Term::ANSIColor 1.04 qw(uncolor); my $names = uncolor('01;31'); print join(q{ }, @{$names}), "\n"; In scalar context, uncolor() returns the list size instead of an array reference. Adding "use strict;" the error is "cannot use string '2' as an array reference". The function works as expected when using @names instead. Reference: Term::ANSIColor 5.00 released https://www.nntp.perl.org/group/perl.perl5.porters/2020/01/msg256833.html

Fri Jan 10 13:33:18 2020 RRA [...] cpan.org - Correspondence added

Subject:	Re: [rt.cpan.org #131414] Example for uncolor() does not work as documented.
Date:	Fri, 10 Jan 2020 10:24:08 -0800
To:	"Joe Smith via RT" <bug-Term-ANSIColor [...] rt.cpan.org>
From:	Russ Allbery <rra [...] cpan.org>

"Joe Smith via RT" <bug-Term-ANSIColor@rt.cpan.org> writes: Show quoted text

> This example does not work:

Show quoted text

> # Map escape sequences back to color names. > use Term::ANSIColor 1.04 qw(uncolor); > my $names = uncolor('01;31'); > print join(q{ }, @{$names}), "\n";

Oh! Doh. I see. Right, uncolor just returns a list, not a reference to an array. The function documentation is correct but the example is wrong. I'll fix this in the next release, and I think I'll make it return the colors as a string in a scalar context since that seems more useful. Thank you for the report and for pointing out what I was confused about! -- #!/usr/bin/perl -- Russ Allbery, Just Another Perl Hacker $^=q;@!>~|{>krw>yn{u<$$<[~||<Juukn{=,<S~|}<Jwx}qn{<Yn{u<Qjltn{ > 0gFzD gD, 00Fz, 0,,( 0hF 0g)F/=, 0> "L$/GEIFewe{,$/ 0C$~> "@=,m,|,(e 0.), 01,pnn,y{ rw} >;,$0=q,$,,($_=$^)=~y,$/ C-~><@=\n\r,-~$:-u/ #y,d,s,(\$.),$1,gee,print

Fri Jan 10 13:33:19 2020 The RT System itself - Status changed from 'new' to 'open'

Fri Jan 17 22:32:17 2020 RRA [...] cpan.org - Correspondence added

I thought about this some more and realized that if I changed the behavior in a scalar context, it might break backward compatibility, so I just fixed the example to match the code and documentation. This fix is now released in 5.01. Thank you for the report!

Sat Jan 18 21:31:21 2020 RRA [...] cpan.org - Fixed in 5.01 added

Sat Jan 18 21:31:21 2020 RRA [...] cpan.org - Status changed from 'open' to 'resolved'

Sat Jan 18 21:31:21 2020 RRA [...] cpan.org - Taken