| Subject: | proper manpage for Term::Size::Perl::Params, typos in pod |
Hi,
while packaging Term::Size::Perl for Debian, our qa tools called my
attention to two issues, and I'd like to share the patches.
First, the pod in Params.pm needs a little more structure so that
lexgrog can deal with the output of pod2man:
--- a/inc/Probe.pm
+++ b/inc/Probe.pm
@@ -110,12 +110,16 @@
use vars qw(\$VERSION);
\$VERSION = @{[MM->parse_version('Perl.pm')]};
-\=head1 Term::Size::Perl::Params
+\=head1 NAME
-\=head2 params
+Term::Size::Perl::Params - parameters for Term::Size::Perl
+
+\=head1 SYNOPSIS
\$href = Term::Size::Perl::Params
+\=head1 DESCRIPTION
+
The configuration parameters C<Term::Size::Perl> needs to
know for retrieving the terminal size with C<ioctl>.
Second, there seems to be a typo in the Perl.pm pod, twice:
--- a/Perl.pm
+++ b/Perl.pm
@@ -38,7 +38,7 @@
C<chars> returns the terminal size in units of characters
corresponding to the given filehandle C<$h>.
-If the argument is ommitted, C<*STDIN{IO}> is used.
+If the argument is omitted, C<*STDIN{IO}> is used.
In scalar context, it returns the terminal width.
=item B<pixels>
@@ -48,7 +48,7 @@
C<pixels> returns the terminal size in units of pixels
corresponding to the given filehandle C<$h>.
-If the argument is ommitted, C<*STDIN{IO}> is used.
+If the argument is omitted, C<*STDIN{IO}> is used.
In scalar context, it returns the terminal width.
Many systems with character-only terminals will return C<(0, 0)>.
Florian