Subject: | Fix POD spelling + add whatis entry |
Hi:
I was packaging this module for Debian and noticed that there is a spelling error (O'Caml -> OCaml) and that one of the POD files is missing a whatis entry (for apropos/the generated manpage).
The following patches (applied in the Debian package, so no re-release of the upstream Forest package is necessary) fixes these issues:
--- a/lib/Forest.pm
+++ b/lib/Forest.pm
@@ -54,9 +54,9 @@
core implementation. There is some good code in here, but the project seems to be
very much on the back-burner at this time.
-=item O'Caml port of Forest
+=item OCaml port of Forest
-Ask me about the O'Caml port of this module, it is also sitting on my hard drive
+Ask me about the OCaml port of this module, it is also sitting on my hard drive
waiting for release. It actually helped quite a bit in terms of helping me settle
on the APIs for this module. Static typing can be very helpful sometimes.
--- a/lib/Forest/Tree/Roles/HasNodeFormatter.pm
+++ b/lib/Forest/Tree/Roles/HasNodeFormatter.pm
@@ -26,6 +26,8 @@
=head1 NAME
+Forest::Tree::Roles::HasNodeFormatter - Moose role to format nodes
+
=head1 SYNOPSIS
=head1 DESCRIPTION
I was packaging this module for Debian and noticed that there is a spelling error (O'Caml -> OCaml) and that one of the POD files is missing a whatis entry (for apropos/the generated manpage).
The following patches (applied in the Debian package, so no re-release of the upstream Forest package is necessary) fixes these issues:
--- a/lib/Forest.pm
+++ b/lib/Forest.pm
@@ -54,9 +54,9 @@
core implementation. There is some good code in here, but the project seems to be
very much on the back-burner at this time.
-=item O'Caml port of Forest
+=item OCaml port of Forest
-Ask me about the O'Caml port of this module, it is also sitting on my hard drive
+Ask me about the OCaml port of this module, it is also sitting on my hard drive
waiting for release. It actually helped quite a bit in terms of helping me settle
on the APIs for this module. Static typing can be very helpful sometimes.
--- a/lib/Forest/Tree/Roles/HasNodeFormatter.pm
+++ b/lib/Forest/Tree/Roles/HasNodeFormatter.pm
@@ -26,6 +26,8 @@
=head1 NAME
+Forest::Tree::Roles::HasNodeFormatter - Moose role to format nodes
+
=head1 SYNOPSIS
=head1 DESCRIPTION