| Subject: | [PATCH] More accurate documentation for link methods |
The follow_link routine is called under the covers in most of the link methods, but the
documentation does not indicate that the links in question will actually be traversed.
This can be especially confusing in the case of $mech->link_content_*, where
"link_content" could be misunderstood to be the innerHTML of the link, not the content
of the resulting page.
--- Orig-Test-WWW-Mechanize-1.12/Mechanize.pm Fri Jul 7 00:47:52 2006
+++ Test-WWW-Mechanize-1.12/Mechanize.pm Fri Jul 7 09:49:37 2006
@@ -449,7 +449,7 @@
=head2 $mech->links_ok( $links [, $desc ] )
-Check the current page for specified links and test for HTTP status
+Follow specified links on the current page and test for HTTP status
200. The links may be specified as a reference to an array containing
L<WWW::Mechanize::Link> objects, an array of URLs, or a scalar URL
name.
@@ -481,7 +481,7 @@
=head2 $mech->link_status_is( $links, $status [, $desc ] )
-Check the current page for specified links and test for HTTP status
+Follow specified links on the current page and test for HTTP status
passed. The links may be specified as a reference to an array
containing L<WWW::Mechanize::Link> objects, an array of URLs, or a
scalar URL name.
@@ -510,7 +510,7 @@
=head2 $mech->link_status_isnt( $links, $status [, $desc ] )
-Check the current page for specified links and test for HTTP status
+Follow specified links on the current page and test for HTTP status
passed. The links may be specified as a reference to an array
containing L<WWW::Mechanize::Link> objects, an array of URLs, or a
scalar URL name.
@@ -540,10 +540,10 @@
=head2 $mech->link_content_like( $links, $regex [, $desc ] )
-Check the current page for specified links and test the content of
-each against I<$regex>. The links may be specified as a reference to
-an array containing L<WWW::Mechanize::Link> objects, an array of URLs,
-or a scalar URL name.
+Follow specified links on the current page and test the resulting
+content of each against I<$regex>. The links may be specified as a
+reference to an array containing L<WWW::Mechanize::Link> objects, an
+array of URLs, or a scalar URL name.
my @links = $mech->followable_links();
$mech->link_content_like( \@links, qr/Restricted/,
@@ -576,10 +576,10 @@
=head2 $mech->link_content_unlike( $links, $regex [, $desc ] )
-Check the current page for specified links and test the content of each
-does not match I<$regex>. The links may be specified as a reference to
-an array containing L<WWW::Mechanize::Link> objects, an array of URLs,
-or a scalar URL name.
+Follow specified links on the current page and test that the resulting
+content of each does not match I<$regex>. The links may be specified as a
+reference to an array containing L<WWW::Mechanize::Link> objects, an array
+of URLs, or a scalar URL name.
my @links = $mech->followable_links();
$mech->link_content_unlike( \@links, qr/Restricted/,