chore: append example in wait

KazuCocoa · web-flow · commit 115465e2b73e · 2021-10-22T01:58:05.000+09:00
diff --git a/lib/appium_lib_core/common/wait.rb b/lib/appium_lib_core/common/wait.rb
@@ -38,6 +38,8 @@ class << self
         #
         #     result = Appium::Core::Wait.until { @driver.find_element(:id, 'something') }
         #
+        #     result = Appium::Core::Wait.until(timeout: 30, message: 'timeout') { @driver.find_element(:id, 'something') }
+        #
         #     result = Appium::Core::Wait.until(object: 'some object') { |object|
         #        @driver.find_element(:id, object)
         #     }
@@ -82,6 +84,8 @@ def until(timeout: DEFAULT_TIMEOUT, interval: DEFAULT_INTERVAL, message: nil, ig
         #
         #     Appium::Core::Wait.until_true { @driver.find_element(:id, 'something') }
         #
+        #     Appium::Core::Wait.until_true(timeout: 30) { @driver.find_element(:id, 'something') }
+        #
         #     Appium::Core::Wait.until_true(object: 'some object') { |object|
         #        @driver.find_element(:id, object)
         #     }
@@ -136,6 +140,7 @@ module Waitable
       # @example
       #
       #   @core.wait_true { @driver.find_element :accessibility_id, 'something' }
+      #   @core.wait_true(timeout: 30, interval: 2) { @driver.find_element :accessibility_id, 'something' }
       #
       def wait_true(timeout: nil, interval: nil, message: nil, ignored: nil)
         Wait.until_true(timeout: timeout || @wait_timeout,
@@ -158,6 +163,7 @@ def wait_true(timeout: nil, interval: nil, message: nil, ignored: nil)
       # @example
       #
       #   @core.wait { @driver.find_element :accessibility_id, 'something' }
+      #   @core.wait(timeout: 30, interval: 2) { @driver.find_element :accessibility_id, 'something' }
       #
       def wait(timeout: nil, interval: nil, message: nil, ignored: nil)
         Wait.until(timeout: timeout || @wait_timeout,

Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,8 @@ class << self`
`38`	`38`	`#`
`39`	`39`	`# result = Appium::Core::Wait.until { @driver.find_element(:id, 'something') }`
`40`	`40`	`#`
	`41`	`+ # result = Appium::Core::Wait.until(timeout: 30, message: 'timeout') { @driver.find_element(:id, 'something') }`
	`42`	`+ #`
`41`	`43`	`# result = Appium::Core::Wait.until(object: 'some object') { \|object\|`
`42`	`44`	`# @driver.find_element(:id, object)`
`43`	`45`	`# }`
`@@ -82,6 +84,8 @@ def until(timeout: DEFAULT_TIMEOUT, interval: DEFAULT_INTERVAL, message: nil, ig`
`82`	`84`	`#`
`83`	`85`	`# Appium::Core::Wait.until_true { @driver.find_element(:id, 'something') }`
`84`	`86`	`#`
	`87`	`+ # Appium::Core::Wait.until_true(timeout: 30) { @driver.find_element(:id, 'something') }`
	`88`	`+ #`
`85`	`89`	`# Appium::Core::Wait.until_true(object: 'some object') { \|object\|`
`86`	`90`	`# @driver.find_element(:id, object)`
`87`	`91`	`# }`
`@@ -136,6 +140,7 @@ module Waitable`
`136`	`140`	`# @example`
`137`	`141`	`#`
`138`	`142`	`# @core.wait_true { @driver.find_element :accessibility_id, 'something' }`
	`143`	`+ # @core.wait_true(timeout: 30, interval: 2) { @driver.find_element :accessibility_id, 'something' }`
`139`	`144`	`#`
`140`	`145`	`def wait_true(timeout: nil, interval: nil, message: nil, ignored: nil)`
`141`	`146`	`Wait.until_true(timeout: timeout \|\| @wait_timeout,`
`@@ -158,6 +163,7 @@ def wait_true(timeout: nil, interval: nil, message: nil, ignored: nil)`
`158`	`163`	`# @example`
`159`	`164`	`#`
`160`	`165`	`# @core.wait { @driver.find_element :accessibility_id, 'something' }`
	`166`	`+ # @core.wait(timeout: 30, interval: 2) { @driver.find_element :accessibility_id, 'something' }`
`161`	`167`	`#`
`162`	`168`	`def wait(timeout: nil, interval: nil, message: nil, ignored: nil)`
`163`	`169`	`Wait.until(timeout: timeout \|\| @wait_timeout,`