| Subject: | document that all routines can croak; other doc fixes |
Essentially all the routines in this package can croak for one reason or
another. For instance, sources() will croak if the file does not exist.
But the only routine for which this is mentioned in the documentation
is the create routine. It is very important for the caller to know this
can happen, so the program can take steps to avoid process death because
of exceptional conditions (i.e., every call to this package should be
done within an eval{}; block if you want your program to survive).
These facts are so important that they should be mentioned up top, in
the general DESCRIPTION text for the package. (For that matter, it
would be a good idea to show this type of enclosure in all the SYNOPSIS
examples as well.)
Also, under update, "... in to the RRD file." should be "... into the
RRD file.", and "attept to create" should be "attempt to create".
Also, under sources, "... within the RRD file." should read "... within
the RRD file, as either an array (in list context) or an arrayref (in
scalar context)."
Also, under basename, "... options. (See below)." should be "... options
(see below).".