| Subject: | Minor documentation update |
There are a few spelling errors within the POD for this module.
Attached is a patch to apply these corrections.
The module's functions can be better described/formatted using
second-level headers, which I've included in here too.
Escapes for < and > characters (for author e-mail) are added as well.
| Subject: | pod.patch |
diff -ru Data-Uniqid-0.11/Uniqid.pm Data-Uniqid/Uniqid.pm
--- Data-Uniqid-0.11/Uniqid.pm 2003-06-03 04:08:32.000000000 +1000
+++ Data-Uniqid/Uniqid.pm 2006-09-29 20:48:06.000000000 +1000
@@ -72,7 +72,7 @@
=head1 NAME
-Data::Uniqid - Perl extension for simple genrating of unique id's
+Data::Uniqid - Perl extension for simple generation of unique id's
=head1 SYNOPSIS
@@ -85,23 +85,27 @@
=head1 DESCRIPTION
Data::Uniqid provides three simple routines for generating unique ids.
-These ids are coded with a Base62 systen to make them short and handy
+These ids are coded with a Base62 system to make them short and handy
(e.g. to use it as part of a URL).
- suinqid
- genrates a very short id valid only for the localhost and with a
- liftime of 1 day
-
- uniqid
- generates a short id valid on the local host
+=head1 FUNCTIONS
+
+=head2 suinqid
+
+Generates a very short id valid only for the local host and with a
+lifetime of 1 day.
+
+=head2 uniqid
+
+Generates a short id valid on the local host.
- luniqid
- generates a long id valid everywhere and ever
+=head2 luniqid
+Generates a long id valid everywhere and ever.
=head1 AUTHOR
-Mike Wesemann, <mwx@gmx.de>
+Mike Wesemann, E<lt>mwx@gmx.deE<gt>
=head1 SEE ALSO