| Subject: | Incomplete documentation for $c->echo function |
| Date: | Mon, 17 Oct 2011 11:53:58 -0400 |
| To: | bug-Net-Citadel [...] rt.cpan.org |
| From: | Robert James Clay <jame [...] rocasa.us> |
In the course of testing a preliminary Debian package for
Net::Citadel v0.02 on Debian v7, I found that the documentation for the
$c->echo function in Citadel.pm is incomplete in that the function
description is missing that it requires a string parameter. Without
that parameter, an error message like the following comes up:
Use of uninitialized value $msg in concatenation (.) or string
at /usr/share/perl5/Net/Citadel.pm line 496
If it is called using something like "$c->echo ('Testing...');", then
there is no error. A possible fix could be to change line 485 from "I<
$c>->echo" to something like "I<$c>->echo ($string)"
Also; the description of the function could perhaps be expanded by
changing it from just "Tests the connection" to something like "Tests
the connection by sending a message string to the Citadel server and
then checking to see if that same string is received back."
Robert James Clay
jame@rocasa.us
jame@cpan.org