| Subject: | Small documentation bug |
| Date: | Sun, 14 Jul 2013 12:28:38 -0700 |
| To: | bug-Email-Simple [...] rt.cpan.org |
| From: | "Ronald F. Guilmette" <rfg [...] tristatelogic.com> |
Hello,
There is a small documentation bug near the top of this page:
http://search.cpan.org/~rjbs/Email-Simple-2.201/lib/Email/Simple/Header.pm
There is a short example under the SYNOPSIS section that reads as follows:
my $email = Email::Simple->new($text);
my $header = $email->head;
print $header->as_string;
The second code line in this example is incorrect code and does not work.
(Gives a compile time error.)
The correct code should, I think, be this:
my $email = Email::Simple->new($text);
my $header = $email->header_obj;
print $header->as_string;
I urge you in no uncertain terms to fix this. I pulled my hair out for at
least a half hour trying to figure out what I was doing wrong, only to
realize that the documentation was wrong.