aboutsummaryrefslogtreecommitdiffstats
path: root/actionsystemtest/lib/action_system_test/driver_adapter.rb
diff options
context:
space:
mode:
authoreileencodes <eileencodes@gmail.com>2016-11-12 17:58:07 -0500
committereileencodes <eileencodes@gmail.com>2017-02-20 15:07:33 -0500
commit4540cebf3ee6c0d2a7e64757460d05cff3bbffbf (patch)
tree98c1421b039d64b8e88c0dddb38d2b20b2a769f1 /actionsystemtest/lib/action_system_test/driver_adapter.rb
parent84f82f0a84de0906d195b529a9f780141c43507a (diff)
downloadrails-4540cebf3ee6c0d2a7e64757460d05cff3bbffbf.tar.gz
rails-4540cebf3ee6c0d2a7e64757460d05cff3bbffbf.tar.bz2
rails-4540cebf3ee6c0d2a7e64757460d05cff3bbffbf.zip
Amend documentation
Many changes have been made since the beginning so documentation needed a refresher.
Diffstat (limited to 'actionsystemtest/lib/action_system_test/driver_adapter.rb')
-rw-r--r--actionsystemtest/lib/action_system_test/driver_adapter.rb10
1 files changed, 6 insertions, 4 deletions
diff --git a/actionsystemtest/lib/action_system_test/driver_adapter.rb b/actionsystemtest/lib/action_system_test/driver_adapter.rb
index 892edd2d32..3a0ab0763a 100644
--- a/actionsystemtest/lib/action_system_test/driver_adapter.rb
+++ b/actionsystemtest/lib/action_system_test/driver_adapter.rb
@@ -2,22 +2,24 @@ require "action_system_test/driver_adapters"
module ActionSystemTest
# The <tt>ActionSystemTest::DriverAdapter</tt> module is used to load the driver
- # set in your Rails' test configuration file.
+ # set in the +system_test_helper+ file generated with your application.
#
# The default driver adapter is the +:rails_selenium_driver+.
module DriverAdapter
extend ActiveSupport::Concern
module ClassMethods
- # Returns the current driver that is set. If no driver is set in the
- # Rails' configuration file then +:rails_selenium_driver+ will be
- # initialized.
+ # Returns the current driver that is set in the <tt>ActionSystemTestCase</tt>
+ # class generated with your Rails application. If no driver is set
+ # +:rails_selenium_driver+ will be initialized.
def driver
@driver ||= DriverAdapters.lookup(DEFAULT_DRIVER)
end
# Specify the adapter and settings for the system test driver set in the
# Rails' configuration file.
+ #
+ # When set, the driver will be initialized.
def driver=(driver)
@driver = DriverAdapters.lookup(driver)
@driver.call