Selaa lähdekoodia

Fix assorted documentation errors

Daniel Gempesaw 9 vuotta sitten
vanhempi
sitoutus
0169584055
4 muutettua tiedostoa jossa 14 lisäystä ja 16 poistoa
  1. 1 2
      README.md
  2. 12 12
      lib/Selenium/Firefox.pm
  3. 0 1
      lib/Selenium/Remote/Driver.pm
  4. 1 1
      weaver.ini

+ 1 - 2
README.md

@@ -200,8 +200,7 @@ useful [example snippets][ex].
 [ie]: https://github.com/gempesaw/Selenium-Remote-Driver/wiki/IE-browser-automation
 [chrome]: https://github.com/gempesaw/Selenium-Remote-Driver/wiki/Chrome-browser-automation
 [pjs]: https://github.com/gempesaw/Selenium-Remote-Driver/wiki/PhantomJS-Headless-Browser-Automation
-[ex]:
-https://github.com/gempesaw/Selenium-Remote-Driver/wiki/Example-Snippets
+[ex]: https://github.com/gempesaw/Selenium-Remote-Driver/wiki/Example-Snippets
 
 ## Selenium IDE Plugin
 

+ 12 - 12
lib/Selenium/Firefox.pm

@@ -21,16 +21,16 @@ extends 'Selenium::Remote::Driver';
 =head1 DESCRIPTION
 
 B<Breaking Changes:> There are breaking changes in v1.0+ of this
-module if you're using it to start FF47; please see L</"Breaking
-Changes">. You can ignore this if you're using v1.0+ of this module to
+module if you're using it to start FF47; please see L</"BREAKING
+CHANGES">. You can ignore this if you're using v1.0+ of this module to
 start FF48.
 
 This class allows you to use the FirefoxDriver without needing the JRE
 or a selenium server running. Unlike starting up an instance of
 S::R::D, do not pass the C<remote_server_addr> and C<port> arguments,
-and we will search for the Firefox executable in your $PATH. We'll try
-to start the binary, connect to it, and shut it down at the end of the
-test.
+and we will search for the Firefox executable in your C<$PATH>. We'll
+try to start the binary, connect to it, and shut it down at the end of
+the test.
 
 If the Firefox application is not found in the expected places, we'll
 fall back to the default L<Selenium::Remote::Driver> behavior of
@@ -74,11 +74,11 @@ apart from the browser itself. This means that:
     my $fx48 = Selenium::Firefox->new;
 
 As with the other drivers, Selenium::Firefox in marionette/geckodriver
-mode requires a `geckodriver` executable in the path or provided
+mode requires a C<geckodriver> executable in the path or provided
 during startup, and it will also attempt to find the path to your
 Firefox browser. During testing, we found that it was necessary for us
-to pass the Firefox browser file path to the `geckodriver` executable
-during start up, or else `geckodriver` would have trouble finding
+to pass the Firefox browser file path to the C<geckodriver> executable
+during start up, or else C<geckodriver> would have trouble finding
 Firefox.
 
 =cut
@@ -96,7 +96,7 @@ browser binary, see the L</firefox_binary> attr.
 
 For Firefox 48 and greater, this is the path to your C<geckodriver>
 executable. If you don't specify anything, we'll search for
-C<geckodriver> in your $PATH.
+C<geckodriver> in your C<$PATH>.
 
 For Firefox 47 and older, this attribute does not apply, because the
 older FF browsers do not use the separate driver binary startup.
@@ -206,8 +206,8 @@ Optional: specify whether
 L<marionette|https://developer.mozilla.org/en-US/docs/Mozilla/QA/Marionette>
 should be enabled or not. By default, marionette is enabled, which
 assumes you are running with Firefox 48 or newer. To use this module
-to start Firefox 47 or older, you must pass C<marionette_enabled =>
-0>.
+to start Firefox 47 or older, you must pass C<<<marionette_enabled =>
+0>>>.
 
     my $ff48 = Selenium::Firefox->new( marionette_enabled => 1 ); # defaults to 1
     my $ff47 = Selenium::Firefox->new( marionette_enabled => 0 );
@@ -222,7 +222,7 @@ has 'marionette_enabled' => (
 =attr firefox_binary
 
 Optional: specify the path to the Firefox browser executable. Although
-we will attempt to locate this in your $PATH, you may specify it
+we will attempt to locate this in your C<$PATH>, you may specify it
 explicitly here. Note that path here must point to a file that exists
 and is executable, or we will croak.
 

+ 0 - 1
lib/Selenium/Remote/Driver.pm

@@ -144,7 +144,6 @@ you please.
         'javascript'           - <boolean>  - whether javascript should be supported
         'accept_ssl_certs'     - <boolean>  - whether SSL certs should be accepted, default is true.
         'firefox_profile'      - Profile    - Use Selenium::Firefox::Profile to create a Firefox profile for the browser to use
-        'marionette_enabled'   - <boolean>  - whether Firefox should enable Marionette. default if false
         'proxy'                - HASH       - Proxy configuration with the following keys:
             'proxyType' - <string> - REQUIRED, Possible values are:
                 direct     - A direct connection - no proxy in use,

+ 1 - 1
weaver.ini

@@ -72,7 +72,7 @@ text = =back
 [GenerateSection / COPYRIGHT AND LICENSE]
 text = Copyright (c) 2010-2011 Aditya Ivaturi, Gordon Child
 text =
-text = Copyright (c) 2014-2015 Daniel Gempesaw
+text = Copyright (c) 2014-2016 Daniel Gempesaw
 text =
 text = Licensed under the Apache License, Version 2.0 (the "License");
 text = you may not use this file except in compliance with the License.