view release on metacpan or  search on metacpan

lib/Net/Citadel/ToDo.pod  view on Meta::CPAN

=pod

=head1 NAME

Net::Citadel::ToDo - To Do items for the Net::Citadel Perl extension.


=head1 TODO

=head2 General

Add a note in the documentation about the Net::Citadel repository and home page
at GitHub? Also include a reference to where it is available at the C<gitpan>
CPAN mirror at GitHub?

Add capability to use SSL encrypted communications with the Citadel server,
perhaps using IO::Socket::SSL?

Change to using the jame@cpan.org address for Robert James Clay instead of the
jame@rocasa.us address?

Other issues: (but uncertain what this is supposed to be about except that it
is related to the POD on those lines):
$ find -type f \( -iname '*.pl' -o -iname '*.pm' \) -exec podlint {} \;
spurious '>' at ./lib/Net/Citadel.pm line 130
spurious '>' at ./lib/Net/Citadel.pm line 285
spurious '>' at ./lib/Net/Citadel.pm line 332
spurious '>' at ./lib/Net/Citadel.pm line 357
spurious '>' at ./lib/Net/Citadel.pm line 383
spurious '>' at ./lib/Net/Citadel.pm line 414
spurious '>' at ./lib/Net/Citadel.pm line 437
spurious '>' at ./lib/Net/Citadel.pm line 468
spurious '>' at ./lib/Net/Citadel.pm line 514
spurious '>' at ./lib/Net/Citadel.pm line 569

$ env PERL5OPT=-m-lib=. perlcritic --noprofile -1 . 2>&1 | grep -vF 'No perl files were found.'
./Makefile.PL: Code is not tidy at line 1, column 1.  See page 33 of PBP.  (Severity: 1)
./Makefile.PL: No package-scoped "$VERSION" variable found at line 1, column 1.  See page 404 of PBP.  (Severity: 2)
./Makefile.PL: Code before strictures are enabled at line 5, column 1.  See page 429 of PBP.  (Severity: 5)
./Makefile.PL: Code before warnings are enabled at line 5, column 1.  See page 431 of PBP.  (Severity: 4)
./Makefile.PL: Heredoc terminator must be quoted at line 32, column 12.  See page 64 of PBP.  (Severity: 3)


=head2 Constants

There are some numbers being used that are actually constants; change to
using Readonly to define them for use in the code, unless there are other
standard constants that can be used, like those for the flock operations.

A "000" string constant is used quite often by Citadel but is not defined in the
module.

There is a set of follow up reply codes noted in the documentation that are not
yet in the module.

Add a link to the online documentation for the status codes:
http://www.citadel.org/doku.php?id=documentation:appproto:statuscodes

A C<NO_SUCH_USER> return code is mentioned in the command documentation (for
the USER command, for instance,) but the module does not currently appear to
define it.

Add a paragraph to the documentation after the CONSTANTS header.

Add a paragraph to the documentation after the 'Results Code' header, perhaps
including a link to the online status codes page in Citadel Documentation.

Add a paragraph to the documentation after the 'Room Access' header, perhaps
including a link to the online page in Citadel Documentation that refers to
them.


=head2 Functions

There does not seem to an explicit function to close the connection; i.e., close
the socket being used to communicate with the server.