| Subject: | Re: [DOC PATCH] prune outdated 'YAPE::Regex::hex' docs |
| Date: | Wed, 20 Feb 2008 16:38:28 -0300 |
| To: | bug-yape-regex <bug-yape-regex [...] rt.cpan.org>, "Jeff Pinyan" <pinyan [...] cpan.org> |
| From: | "Adriano Ferreira" <a.r.ferreira [...] gmail.com> |
The previous patch is wrong. I thought there was a duplicate doc for
YAPE::Regex::hex, but no. The section I thought that should be pruned
is in fact the documentation of YAPE::Regex::text.
So the previous patch should be ignored.
And the actual needed doc patch is smaller.
diff -ru YAPE-Regex-3.03/Regex/Element.pm YAPE-Regex/Regex/Element.pm
--- YAPE-Regex-3.03/Regex/Element.pm 2001-05-02 21:13:34.000000000 -0300
+++ YAPE-Regex/Regex/Element.pm 2008-02-20 16:35:15.000000000 -0300
@@ -732,9 +732,9 @@
=back
-=head2 Methods for C<YAPE::Regex::hex>
+=head2 Methods for C<YAPE::Regex::text>
-This class represents hexadecimal escapes. Objects have the following methods:
+This class represents literal text. Objects have the following methods:
=over 4
On Feb 20, 2008 2:51 PM, Adriano Ferreira <a.r.ferreira@gmail.com> wrote:
Show quoted text
> At the docs of release 3.03, there are in fact two sections named:
>
> "Methods for YAPE::Regex::hex"
>
> as it can be seen in the index of the rendered POD page at search.cpan.org:
>
> http://search.cpan.org/~pinyan/YAPE-Regex-3.03/Regex/Element.pm
>
> However by a failure of the rendered POD, every time we click on the
> linked section, we jump to the first one. The second looks like an
> outdated section which was forgotten by mistake.
>
> So the current patch prunes this piece of docs.
>
> Regards,
> Adriano Ferreira
>
> diff -ru YAPE-Regex-3.03/Regex/Element.pm YAPE-Regex/Regex/Element.pm
> --- YAPE-Regex-3.03/Regex/Element.pm 2001-05-02 21:13:34.000000000 -0300
> +++ YAPE-Regex/Regex/Element.pm 2008-02-20 14:44:32.000000000 -0300
> @@ -732,31 +732,6 @@
>
> =back
>
> -=head2 Methods for C<YAPE::Regex::hex>
> -
> -This class represents hexadecimal escapes. Objects have the following methods:
> -
> -=over 4
> -
> -=item * C<my $text = YAPE::Regex::text-E<gt>new($text,$q,$ng);>
> -
> -Creates a C<YAPE::Regex::text> object. Takes three arguments: the text, the
> -quantity, and the non-greedy flag. The quantity and non-greedy modifier should
> -only be present for I<single-character> text, because of the way the parser
> -renders the quantity and non-greedy modifier.
> -
> - my $text = YAPE::Regex::text->new('alphabet','');
> - # /alphabet/
> -
> - my $text = YAPE::Regex::text->new('x','?','?');
> - # /x??/
> -
> -=item * C<my $type = $text-E<gt>type;>
> -
> -Returns the string C<text>.
> -
> -=back
> -
> =head2 Methods for C<YAPE::Regex::alt>
>
> This class represents alternation. Objects have the following methods:
>
Message body is not shown because sender requested not to inline it.