| Subject: | [PATCH] Fix POD spelling + whatis entries |
The following patch fixes POD spelling errors:
--- a/lib/Dancer/Request.pm
+++ b/lib/Dancer/Request.pm
@@ -490,7 +490,7 @@
=head2 env()
-Return the current environement (C<%ENV>), as a hashref.
+Return the current environment (C<%ENV>), as a hashref.
=head2 uploads()
@@ -500,7 +500,7 @@
=head2 HTTP environment variables
-All HTTP environement variables that are in %ENV will be provided in the
+All HTTP environment variables that are in %ENV will be provided in the
Dancer::Request object through specific accessors, here are those
supported:
=over 4
And the following patch adds whatis entries (short descriptions next to
the module name) for use by both CPAN and common tools (mandb, apropos,
etc). Here's a description of what a whatis entry is, from lintian:
W: libdancer-perl: manpage-has-bad-whatis-entry
usr/share/man/man3/Dancer::Config.3pm.gz
N:
N: Each manual page should start with a "NAME" section, which lists the
N: name and a brief description of the page separated by "\-". The "NAME"
N: section is parsed by lexgrog and used to generate a database that's
N: queried by commands like apropos and whatis. This tag indicates that
N: lexgrog was unable to parse the NAME section of this manual page.
N:
N: For manual pages that document multiple programs, functions, files, or
N: other things, the part before "\-" should list each separated by a
comma
N: and a space. Each thing listed must not contain spaces; a man page
for a
N: two-part command like "fs listacl" must use something like
"fs_listacl"
N: in the "NAME" section so that it can be parsed by lexgrog.
N:
N: Refer to the lexgrog(1) manual page, the groff_man(7) manual page, and
N: the groff_mdoc(7) manual page for details.
N:
N: Severity: normal, Certainty: certain
--- a/lib/Dancer/Config.pm
+++ b/lib/Dancer/Config.pm
@@ -140,7 +140,7 @@
=head1 NAME
-Dancer::Config
+Dancer::Config - Setting registry for Dancer
=head1 DESCRIPTION
--- a/lib/Dancer/HTTP.pm
+++ b/lib/Dancer/HTTP.pm
@@ -88,7 +88,7 @@
=head1 NAME
-Dancer::HTTP
+Dancer::HTTP - helper for rendering HTTP status codes
=head1 DESCRIPTION
--- a/lib/Dancer/Request.pm
+++ b/lib/Dancer/Request.pm
@@ -405,7 +405,7 @@
=head1 NAME
-Dancer::Request
+Dancer::Request - interface for accessing incoming requests
=head1 DESCRIPTION
Anyway, I've patched them in the Debian package which should be uploaded
later, so there's no need for you to re-upload these changes. However,
it'd be handy if you had them in your version control to ship with the
next release, so I can remove the patches (you guys will probably be
better equipped to write the short descriptions, too).
Cheers,
Jonathan