Subject: | Documentation issues: Missing ";", wrong bug report address, and outdated URLs |
Date: | Thu, 1 Oct 2020 15:55:44 +0200 |
To: | bug-Test-Command-Simple [...] rt.cpan.org |
From: | Axel Beckert <abe [...] deuxchevaux.org> |
Dear Darin,
I noticed somes issues in the POD/man page of Test::Command::Simple:
Real but minor/obvious bugs
---------------------------
In line 4 of the example code in the SYNOPSIS section, there is a
missing semicolon:
1 use Test::Command::Simple;
2
3 run('echo', 'has this output'); # only tests that the command can be started, not checking rc
4 is(rc,0,'Returned successfully')
HERE -^
5 like(stdout,qr/has this output/,'Testing stdout');
6 is(length stderr, 0,'No stderr');
See also https://metacpan.org/pod/Test::Command::Simple#SYNOPSIS
In the section BUGS, there is the bug report e-mail address given for
Test::Command and not Test::Command::Simple:
Please report any bugs or feature requests to bug-test-command at
rt.cpan.org. [...]
(The bug report web interface URL is fine, though.)
See also https://metacpan.org/pod/Test::Command::Simple#BUGS
Some more nitpicks respectively improvement suggestions
-------------------------------------------------------
* Replace all occurrences of "http://rt.cpan.org/" with
"https://rt.cpan.org/" to avoid one redirect.
* Replace http://search.cpan.org/dist/Test-Command-Simple/ with
https://metacpan.org/release/Test-Command-Simple as it redirects
there anyways.
* Drop the item mentioning
hXXp://annocpan[.]org/dist/Test-Command-Simple — it points to a
domain grabber nowadays. (I've obfuscated the URL in here to not add
another link to that domain grabber.)
Kind regards, Axel (ABE)
--
PGP: 2FF9CD59612616B5 /~\ Plain Text Ribbon Campaign, http://arc.pasp.de/
Mail: abe@deuxchevaux.org \ / Say No to HTML in E-Mail and Usenet
Mail+Jabber: abe@noone.org X
https://axel.beckert.ch/ / \ I love long mails: https://email.is-not-s.ms/
Message body not shown because it is not plain text.