Skip to content

Commit 9e7615d

Browse files
authored
[rb] Replace the :capabilities paramater with :options in API examples (#12626)
The :capabilities parameter for webdriver classes is deprecated but still used in API example docs. This change replaces the :capabilities parameter with :options.
1 parent 739d177 commit 9e7615d

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

rb/lib/selenium/webdriver/chromium/options.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ class Options < WebDriver::Options
4747
#
4848
# @example
4949
# options = Selenium::WebDriver::Chrome::Options.new(args: ['start-maximized', 'user-data-dir=/tmp/temp_profile'])
50-
# driver = Selenium::WebDriver.for(:chrome, capabilities: options)
50+
# driver = Selenium::WebDriver.for(:chrome, options: options)
5151
#
5252
# @param [Profile] profile An instance of a Chrome::Profile Class
5353
# @param [Hash] opts the pre-defined options to create the Chrome::Options with

rb/lib/selenium/webdriver/firefox/options.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ class Options < WebDriver::Options
4545
#
4646
# @example
4747
# options = Selenium::WebDriver::Firefox::Options.new(args: ['--host=127.0.0.1'])
48-
# driver = Selenium::WebDriver.for :firefox, capabilities: options
48+
# driver = Selenium::WebDriver.for :firefox, options: options
4949
#
5050
# @param [Hash] opts the pre-defined options to create the Firefox::Options with
5151
# @option opts [String] :binary Path to the Firefox executable to use

rb/lib/selenium/webdriver/ie/options.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,12 @@ class Options < WebDriver::Options
5353
#
5454
# @example
5555
# options = Selenium::WebDriver::IE::Options.new(args: ['--host=127.0.0.1'])
56-
# driver = Selenium::WebDriver.for(:ie, capabilities: options)
56+
# driver = Selenium::WebDriver.for(:ie, options: options)
5757
#
5858
# @example
5959
# options = Selenium::WebDriver::IE::Options.new
6060
# options.element_scroll_behavior = Selenium::WebDriver::IE::Options::SCROLL_BOTTOM
61-
# driver = Selenium::WebDriver.for(:ie, capabilities: options)
61+
# driver = Selenium::WebDriver.for(:ie, options: options)
6262
#
6363
# @param [Hash] opts the pre-defined options
6464
# @option opts [Array<String>] args

0 commit comments

Comments
 (0)