Update docstring (#407)

* Remove import error on pycharm

And update docstring

* Update docstring

* Update docstring

* Fix import error

* fix

* fix import order

* tweak

Author: ki4070ma

.isort.cfg

@@ -1,3 +1,4 @@
 [settings]
 multi_line_output = 3
 known_third_party = dateutil,httpretty,pytest,selenium,setuptools,urllib3
+known_first_party = test

appium/webdriver/common/touch_action.py

@@ -37,7 +37,7 @@ def tap(self, element=None, x=None, y=None, count=1):
         """Perform a tap action on the element
 
         Args:
-            element (`WebElement`): the element to tap
+            element (`appium.webdriver.webelement.WebElement`): the element to tap
             x (:obj:`int`, optional): x coordinate to tap, relative to the top left corner of the element.
             y (:obj:`int`, optional): y coordinate. If y is used, x must also be set, and vice versa
 
@@ -54,7 +54,7 @@ def press(self, el=None, x=None, y=None, pressure=None):
         """Begin a chain with a press down action at a particular element or point
 
         Args:
-            el (:obj:`WebElement`, optional): the element to press
+            el (:obj:`appium.webdriver.webelement.WebElement`, optional): the element to press
             x (:obj:`int`, optional): x coordiate to press. If y is used, x must also be set
             y (:obj:`int`, optional): y coordiate to press. If x is used, y must also be set
             pressure (:obj:`float`, optional): [iOS Only] press as force touch. Read the description of `force` property on Apple's UITouch class
@@ -71,7 +71,7 @@ def long_press(self, el=None, x=None, y=None, duration=1000):
         """Begin a chain with a press down that lasts `duration` milliseconds
 
         Args:
-            el (:obj:`WebElement`, optional): the element to press
+            el (:obj:`appium.webdriver.webelement.WebElement`, optional): the element to press
             x (:obj:`int`, optional): x coordiate to press. If y is used, x must also be set
             y (:obj:`int`, optional): y coordiate to press. If x is used, y must also be set
             duration (:obj:`int`, optional): Duration to press
@@ -105,7 +105,7 @@ def move_to(self, el=None, x=None, y=None):
         """Move the pointer from the previous point to the element or point specified
 
         Args:
-            el (:obj:`WebElement`, optional): the element to be moved to
+            el (:obj:`appium.webdriver.webelement.WebElement`, optional): the element to be moved to
             x (:obj:`int`, optional): x coordiate to be moved to. If y is used, x must also be set
             y (:obj:`int`, optional): y coordiate to be moved to. If x is used, y must also be set
 

appium/webdriver/extensions/action_helpers.py

@@ -24,16 +24,16 @@ def scroll(self, origin_el, destination_el, duration=None):
         """Scrolls from one element to another
 
         Args:
-            originalEl (`WebElement`): the element from which to being scrolling
-            destinationEl (`WebElement`): the element to scroll to
+            originalEl (`appium.webdriver.webelement.WebElement`): the element from which to being scrolling
+            destinationEl (`appium.webdriver.webelement.WebElement`): the element to scroll to
             duration (int): a duration after pressing originalEl and move the element to destinationEl.
                 Default is 600 ms for W3C spec. Zero for MJSONWP.
 
         Usage:
             driver.scroll(el1, el2)
 
         Returns:
-            `WebElement`
+            `appium.webdriver.webelement.WebElement`
         """
 
         # XCUITest x W3C spec has no duration by default in server side
@@ -51,11 +51,11 @@ def drag_and_drop(self, origin_el, destination_el):
         """Drag the origin element to the destination element
 
         Args:
-            originEl (`WebElement`): the element to drag
-            destinationEl (`WebElement`): the element to drag to
+            originEl (`appium.webdriver.webelement.WebElement`): the element to drag
+            destinationEl (`appium.webdriver.webelement.WebElement`): the element to drag to
 
         Returns:
-            `WebElement`
+            `appium.webdriver.webelement.WebElement`
         """
         action = TouchAction(self)
         action.long_press(origin_el).move_to(destination_el).release().perform()
@@ -74,7 +74,7 @@ def tap(self, positions, duration=None):
             driver.tap([(100, 20), (100, 60), (100, 100)], 500)
 
         Returns:
-            `WebElement`
+            `appium.webdriver.webelement.WebElement`
         """
         if len(positions) == 1:
             action = TouchAction(self)
@@ -114,7 +114,7 @@ def swipe(self, start_x, start_y, end_x, end_y, duration=None):
             driver.swipe(100, 100, 100, 400)
 
         Returns:
-            `WebElement`
+            `appium.webdriver.webelement.WebElement`
         """
         # `swipe` is something like press-wait-move_to-release, which the server
         # will translate into the correct action
@@ -140,7 +140,7 @@ def flick(self, start_x, start_y, end_x, end_y):
             driver.flick(100, 100, 100, 400)
 
         Returns:
-            `WebElement`
+            `appium.webdriver.webelement.WebElement`
         """
         action = TouchAction(self)
         action \

appium/webdriver/extensions/android/gsm.py

@@ -54,7 +54,7 @@ def make_gsm_call(self, phone_number, action):
         Args:
             phone_number (str): The phone number to call to.
             action (str): The call action.
-                A member of the const appium.webdriver.extensions.android.gsm.GsmCallActions
+                A member of the const `appium.webdriver.extensions.android.gsm.GsmCallActions`
 
         :Usage:
             self.driver.make_gsm_call('5551234567', GsmCallActions.CALL)
@@ -73,7 +73,7 @@ def set_gsm_signal(self, strength):
 
         Args:
             strength (int): Signal strength.
-                A member of the enum appium.webdriver.extensions.android.gsm.GsmSignalStrength
+                A member of the enum `appium.webdriver.extensions.android.gsm.GsmSignalStrength`
 
         Usage:
             self.driver.set_gsm_signal(GsmSignalStrength.GOOD)
@@ -92,7 +92,7 @@ def set_gsm_voice(self, state):
 
         Args:
             state (str): State of GSM voice.
-                A member of the const appium.webdriver.extensions.android.gsm.GsmVoiceState
+                A member of the const `appium.webdriver.extensions.android.gsm.GsmVoiceState`
 
         Usage:
             self.driver.set_gsm_voice(GsmVoiceState.HOME)

appium/webdriver/extensions/android/network.py

@@ -59,7 +59,7 @@ def set_network_connection(self, connection_type):
             connection_type (int): a member of the enum appium.webdriver.ConnectionType
 
         Returns:
-            `WebDriver`
+            `appium.webdriver.webdriver.WebDriver`
         """
         data = {
             'parameters': {
@@ -72,7 +72,7 @@ def toggle_wifi(self):
         """Toggle the wifi on the device, Android only.
 
         Returns:
-            `WebDriver`
+            `appium.webdriver.webdriver.WebDriver`
         """
         self.execute(Command.TOGGLE_WIFI, {})
         return self
@@ -90,7 +90,7 @@ def set_network_speed(self, speed_type):
             self.driver.set_network_speed(NetSpeed.LTE)
 
         Returns:
-            `WebDriver`
+            `appium.webdriver.webdriver.WebDriver`
         """
         constants = extract_const_attributes(NetSpeed)
         if speed_type not in constants.values():

appium/webdriver/extensions/android/power.py

@@ -33,7 +33,7 @@ def set_power_capacity(self, percent):
             self.driver.set_power_capacity(50)
 
         Returns:
-            `WebDriver`
+            `appium.webdriver.webdriver.WebDriver`
         """
         self.execute(Command.SET_POWER_CAPACITY, {'percent': percent})
         return self
@@ -51,7 +51,7 @@ def set_power_ac(self, ac_state):
             self.driver.set_power_ac(Power.AC_ON)
 
         Returns:
-            `WebDriver`
+            `appium.webdriver.webdriver.WebDriver`
         """
         self.execute(Command.SET_POWER_AC, {'state': ac_state})
         return self

appium/webdriver/extensions/android/sms.py

@@ -32,7 +32,7 @@ def send_sms(self, phone_number, message):
             self.driver.send_sms('555-123-4567', 'Hey lol')
 
         Returns:
-            `WebDriver`
+            `appium.webdriver.webdriver.WebDriver`
         """
         self.execute(Command.SEND_SMS, {'phoneNumber': phone_number, 'message': message})
         return self

appium/webdriver/extensions/applications.py

@@ -25,7 +25,7 @@ def background_app(self, seconds):
             seconds (int): the duration for the application to remain in the background
 
         Returns:
-            `WebDriver`
+            `appium.webdriver.webdriver.WebDriver`
         """
         data = {
             'seconds': seconds,
@@ -37,7 +37,7 @@ def is_app_installed(self, bundle_id):
         """Checks whether the application specified by `bundle_id` is installed on the device.
 
         Args:
-            bundle_id (int): the id of the application to query
+            bundle_id (str): the id of the application to query
 
         Returns:
             bool: `True` if app is installed
@@ -65,7 +65,7 @@ def install_app(self, app_path, **options):
                 on Android 6+ after the installation completes. False by default
 
         Returns:
-            `WebDriver`
+            `appium.webdriver.webdriver.WebDriver`
         """
         data = {
             'appPath': app_path,
@@ -88,7 +88,7 @@ def remove_app(self, app_id, **options):
                 20000ms by default.
 
         Returns:
-            `WebDriver`
+            `appium.webdriver.webdriver.WebDriver`
         """
         data = {
             'appId': app_id,
@@ -102,7 +102,7 @@ def launch_app(self):
         """Start on the device the application specified in the desired capabilities.
 
         Returns:
-            `WebDriver`
+            `appium.webdriver.webdriver.WebDriver`
         """
         self.execute(Command.LAUNCH_APP)
         return self
@@ -112,7 +112,7 @@ def close_app(self):
         the device.
 
         Returns:
-            `WebDriver`
+            `appium.webdriver.webdriver.WebDriver`
         """
         self.execute(Command.CLOSE_APP)
         return self
@@ -145,7 +145,7 @@ def activate_app(self, app_id):
             app_id (str): the application id to be activated
 
         Returns:
-            `WebDriver`
+            `appium.webdriver.webdriver.WebDriver`
         """
         data = {
             'appId': app_id,

appium/webdriver/extensions/hw_actions.py

@@ -29,7 +29,7 @@ def lock(self, seconds=None):
                 the timeout expires and unlocks the screen automatically.
 
         Returns:
-            `WebDriver`
+            `appium.webdriver.webdriver.WebDriver`
         """
         if seconds is None:
             self.execute(Command.LOCK)
@@ -42,7 +42,7 @@ def unlock(self):
         """Unlock the device. No changes are made if the device is already locked.
 
         Returns:
-            `WebDriver`
+            `appium.webdriver.webdriver.WebDriver`
         """
         self.execute(Command.UNLOCK)
         return self
@@ -59,7 +59,7 @@ def shake(self):
         """Shake the device.
 
         Returns:
-            `WebDriver`
+            `appium.webdriver.webdriver.WebDriver`
         """
         self.execute(Command.SHAKE)
         return self
@@ -71,7 +71,7 @@ def touch_id(self, match):
             match (bool): Simulates a successful touch (`True`) or a failed touch (`False`)
 
         Returns:
-            `WebDriver`
+            `appium.webdriver.webdriver.WebDriver`
         """
         data = {
             'match': match
@@ -83,7 +83,7 @@ def toggle_touch_id_enrollment(self):
         """Toggle enroll touchId on iOS Simulator
 
         Returns:
-            `WebDriver`
+            `appium.webdriver.webdriver.WebDriver`
         """
         self.execute(Command.TOGGLE_TOUCH_ID_ENROLLMENT)
         return self

appium/webdriver/extensions/ime.py

@@ -50,7 +50,7 @@ def activate_ime_engine(self, engine):
                (e.g., 'com.android.inputmethod.latin/.LatinIME')
 
         Returns:
-            `WebDriver`
+            `appium.webdriver.webdriver.WebDriver`
         """
         data = {
             'engine': engine
@@ -64,7 +64,7 @@ def deactivate_ime_engine(self):
         Android only.
 
         Returns:
-            `WebDriver`
+            `appium.webdriver.webdriver.WebDriver`
         """
         self.execute(Command.DEACTIVATE_IME_ENGINE, {})
         return self