docs: add docstring

appium · Mar 20, 2021 · b9e47aa · b9e47aa
1 parent 954a2fe
commit b9e47aa
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 8 deletions.
diff --git a/lib/appium_lib_core/common/base/driver.rb b/lib/appium_lib_core/common/base/driver.rb
@@ -164,10 +164,24 @@ def initialize(bridge)
             @bridge = bridge
           end
 
+          # Get appium Settings for current test session.
+          #
+          # @example
+          #
+          #   @driver.settings.get
+          #
           def get
             @bridge.get_settings
           end
 
+          # Update Appium Settings for current test session
+          #
+          # @param [Hash] settings Settings to update, keys are settings, values to value to set each setting to
+          #
+          # @example
+          #
+          #   @driver.settings.update({'allowInvisibleElements': true})
+          #
           def update(settings)
             @bridge.update_settings(settings)
           end
@@ -204,8 +218,8 @@ def get_settings
         #
         # @example
         #
-        #   @driver.update_settings('allowInvisibleElements': true)
-        #   @driver.settings.update('allowInvisibleElements': true)
+        #   @driver.update_settings({ 'allowInvisibleElements': true })
+        #   @driver.settings.update({ 'allowInvisibleElements': true })
         #   @driver.settings = { 'allowInvisibleElements': true }
         #
         def settings=(value)

diff --git a/test/functional/android/android/device_data_test.rb b/test/functional/android/android/device_data_test.rb
@@ -56,10 +56,10 @@ def test_settings
 
         assert_equal(false, @driver.get_settings['ignoreUnimportantViews'])
 
-        @driver.update_settings('ignoreUnimportantViews' => true)
+        @driver.update_settings({ 'ignoreUnimportantViews' => true })
         assert_equal(true, @driver.get_settings['ignoreUnimportantViews'])
 
-        @driver.update_settings('ignoreUnimportantViews' => false)
+        @driver.update_settings({ 'ignoreUnimportantViews' => false })
         assert_equal(false, @driver.get_settings['ignoreUnimportantViews'])
       end
 

diff --git a/test/functional/ios/ios/device_test.rb b/test/functional/ios/ios/device_test.rb
@@ -196,10 +196,10 @@ def test_pull_folder
       def test_settings
         assert_equal(false, @@driver.get_settings['nativeWebTap'])
 
-        @@driver.update_settings('nativeWebTap' => true)
+        @@driver.update_settings({ 'nativeWebTap' => true })
         assert_equal(true, @@driver.get_settings['nativeWebTap'])
 
-        @@driver.update_settings('nativeWebTap' => false)
+        @@driver.update_settings({ 'nativeWebTap' => false })
       end
 
       def test_touch_actions

diff --git a/test/unit/android/device/mjsonwp/commands_test.rb b/test/unit/android/device/mjsonwp/commands_test.rb
@@ -203,7 +203,7 @@ def test_update_settings
             stub_request(:post, "#{SESSION}/appium/settings")
               .to_return(headers: HEADER, status: 200, body: { value: '' }.to_json)
 
-            @driver.update_settings(sample: 'value')
+            @driver.update_settings({ sample: 'value' })
 
             assert_requested(:post, "#{SESSION}/appium/settings", times: 1)
           end

diff --git a/test/unit/android/device/w3c/commands_test.rb b/test/unit/android/device/w3c/commands_test.rb
@@ -202,7 +202,7 @@ def test_update_settings
             stub_request(:post, "#{SESSION}/appium/settings")
               .to_return(headers: HEADER, status: 200, body: { value: '' }.to_json)
 
-            @driver.update_settings(sample: 'value')
+            @driver.update_settings({ sample: 'value' })
 
             assert_requested(:post, "#{SESSION}/appium/settings", times: 1)
           end