Browse Source

Merge pull request #467 from bschmalhofer/master

POD improvements for Test::Selenium::Remote::Driver
George S. Baugh 4 years ago
parent
commit
0f20d9d238
1 changed files with 23 additions and 22 deletions
  1. 23 22
      lib/Test/Selenium/Remote/Driver.pm

+ 23 - 22
lib/Test/Selenium/Remote/Driver.pm

@@ -90,15 +90,15 @@ sub BUILD {
 
 
 =head1 NAME
 =head1 NAME
 
 
-Test::Selenium::Remote::Driver
+Test::Selenium::Remote::Driver - add testing methods to L<Selenium::Remote::Driver>
 
 
 =head1 DESCRIPTION
 =head1 DESCRIPTION
 
 
-A subclass of L<Selenium::Remote::Driver>.  which provides useful testing
-functions.
+A subclass of L<Selenium::Remote::Driver> which provides useful testing
+methods.
 
 
 This is an I<experimental> addition to the Selenium::Remote::Driver
 This is an I<experimental> addition to the Selenium::Remote::Driver
-distribution, and some interfaces may change.
+distribution. Some interfaces may change.
 
 
 =head1 Methods
 =head1 Methods
 
 
@@ -122,6 +122,7 @@ C<$TWD_PLATFORM>, C<$TWD_JAVASCRIPT>, C<$TWD_EXTRA_CAPABILITIES>.
 
 
 C<$TWD_BROWSER> is actually an alias for C<$TWD_BROWSER_NAME>.
 C<$TWD_BROWSER> is actually an alias for C<$TWD_BROWSER_NAME>.
 C<$TWD_HOST> is actually an alias for C<$TWD_REMOTE_SERVER_ADDR>.
 C<$TWD_HOST> is actually an alias for C<$TWD_REMOTE_SERVER_ADDR>.
+The aliases habe lower precedence than the original values.
 
 
 See L<Selenium::Remote::Driver> for the meanings of these options.
 See L<Selenium::Remote::Driver> for the meanings of these options.
 
 
@@ -161,10 +162,10 @@ has verbose => ( is => 'rw', );
 =head2 server_is_running( $host, $port )
 =head2 server_is_running( $host, $port )
 
 
 Returns true if a Selenium server is running.  The host and port
 Returns true if a Selenium server is running.  The host and port
-parameters are optional, and default to C<localhost:4444>.
+parameters are optional, and they default to C<localhost:4444>.
 
 
-Environment vars C<TWD_HOST> and C<TWD_PORT> can also be used to
-determine the server to check.
+The environment vars C<TWD_HOST> and C<TWD_PORT> can also be used to
+determine which server should be checked.
 
 
 =cut
 =cut
 
 
@@ -231,11 +232,11 @@ output if you do not handle it properly.
 
 
 =head1 Testing Methods
 =head1 Testing Methods
 
 
-The following testing methods are available. For
-more documentation, see the related test methods in L<Selenium::Remote::Driver>
+The following testing methods are available.
+For more documentation, see the related methods in L<Selenium::Remote::Driver>.
 (And feel free to submit a patch to flesh out the documentation for these here).
 (And feel free to submit a patch to flesh out the documentation for these here).
 Defaults for optional arguments B<should> be the same as for their analogues in
 Defaults for optional arguments B<should> be the same as for their analogues in
-L<Selenium::Remote::Driver> and L<Selenium::Remote::WebElement>.
+L<Selenium::Remote::Driver>.
 
 
     alert_text_is
     alert_text_is
     alert_text_isnt
     alert_text_isnt
@@ -570,12 +571,12 @@ sub content_unlike {
 
 
 Tells if the text of the page (as returned by C<< get_body() >>)  matches
 Tells if the text of the page (as returned by C<< get_body() >>)  matches
 I<$regex>. If an arrayref of regex's are provided, one 'test' is run for each
 I<$regex>. If an arrayref of regex's are provided, one 'test' is run for each
-regex against the content of the current page.
+regex against the text of the current page.
 
 
-A default description of 'Content is like "$regex"' will be provided if there
+A default description of 'Text is like "$regex"' will be provided if there
 is no description.
 is no description.
 
 
-To also match the HTML see, C<< content_unlike() >>.
+To also match the HTML, see C<< content_unlike() >>.
 
 
 =cut
 =cut
 
 
@@ -614,14 +615,14 @@ sub body_text_like {
    $twd->body_text_unlike( [$regex_1, $regex_2] [, $desc ] )
    $twd->body_text_unlike( [$regex_1, $regex_2] [, $desc ] )
 
 
 Tells if the text of the page (as returned by C<< get_body() >>)
 Tells if the text of the page (as returned by C<< get_body() >>)
- does NOT match I<$regex>. If an arrayref of regex's
-are provided, one 'test' is run for each regex against the content of the
+does NOT match I<$regex>. If an arrayref of regex's
+are provided, one 'test' is run for each regex against the text of the
 current page.
 current page.
 
 
 A default description of 'Text is unlike "$regex"' will be provided if there
 A default description of 'Text is unlike "$regex"' will be provided if there
 is no description.
 is no description.
 
 
-To also match the HTML see, C<< content_unlike() >>.
+To also match the HTML, see C<< content_unlike() >>.
 
 
 =cut
 =cut
 
 
@@ -662,7 +663,7 @@ sub body_text_unlike {
    $twd->content_contains( $str [, $desc ] )
    $twd->content_contains( $str [, $desc ] )
    $twd->content_contains( [$str_1, $str_2] [, $desc ] )
    $twd->content_contains( [$str_1, $str_2] [, $desc ] )
 
 
-Tells if the content of the page contains I<$str>. If an arrayref of strngs's
+Tells if the content of the page contains I<$str>. If an arrayref of strings
 are provided, one 'test' is run for each string against the content of the
 are provided, one 'test' is run for each string against the content of the
 current page.
 current page.
 
 
@@ -751,12 +752,12 @@ sub content_lacks {
 
 
 Tells if the text of the page (as returned by C<< get_body() >>) contains
 Tells if the text of the page (as returned by C<< get_body() >>) contains
 I<$str>. If an arrayref of strings are provided, one 'test' is run for each
 I<$str>. If an arrayref of strings are provided, one 'test' is run for each
-regex against the content of the current page.
+string against the text of the current page.
 
 
 A default description of 'Text contains "$str"' will be provided if there
 A default description of 'Text contains "$str"' will be provided if there
 is no description.
 is no description.
 
 
-To also match the HTML see, C<< content_uncontains() >>.
+To also match the HTML, see C<< content_lacks() >>.
 
 
 =cut
 =cut
 
 
@@ -795,14 +796,14 @@ sub body_text_contains {
    $twd->body_text_lacks( [$str_1, $str_2] [, $desc ] )
    $twd->body_text_lacks( [$str_1, $str_2] [, $desc ] )
 
 
 Tells if the text of the page (as returned by C<< get_body() >>)
 Tells if the text of the page (as returned by C<< get_body() >>)
- does NOT contain I<$str>. If an arrayref of strings
-are provided, one 'test' is run for each regex against the content of the
+does NOT contain I<$str>. If an arrayref of strings
+are provided, one 'test' is run for each string against the content of the
 current page.
 current page.
 
 
 A default description of 'Text lacks "$str"' will be provided if there
 A default description of 'Text lacks "$str"' will be provided if there
 is no description.
 is no description.
 
 
-To also match the HTML see, C<< content_lacks() >>.
+To also match the HTML, see C<< content_lacks() >>.
 
 
 =cut
 =cut