Refactor docstrings for clarity and conciseness across multiple files

Author: iampopovich

py/selenium/webdriver/wpewebkit/options.py

@@ -29,9 +29,7 @@ def __init__(self) -> None:
 
     @property
     def binary_location(self) -> str:
-        """Returns the location of the browser binary otherwise an empty
-        string.
-        """
+        """Return the location of the browser binary or an empty string."""
         return self._binary_location
 
     @binary_location.setter
@@ -45,10 +43,8 @@ def binary_location(self, value: str) -> None:
             raise TypeError(self.BINARY_LOCATION_ERROR)
         self._binary_location = value
 
-    def to_capabilities(self):
-        """Creates a capabilities with all the options that have been set and
-        returns a dictionary with everything.
-        """
+    def to_capabilities(self) -> dict:
+        """Create a capabilities dictionary with all set options."""
         caps = self._caps
 
         browser_options = {}

py/selenium/webdriver/wpewebkit/service.py

@@ -25,8 +25,7 @@
 
 
 class Service(service.Service):
-    """A Service class that is responsible for the starting and stopping of
-    `WPEWebDriver`.
+    """A Service class that is responsible for the starting and stopping of `WPEWebDriver`.
 
     Args:
         executable_path: Install path of the WPEWebDriver executable, defaults

py/selenium/webdriver/wpewebkit/webdriver.py

@@ -49,9 +49,7 @@ def __init__(
         self._is_remote = False
 
     def quit(self):
-        """Closes the browser and shuts down the WPEWebKitDriver executable
-        that is started when starting the WPEWebKitDriver.
-        """
+        """Close the browser and shut down the WPEWebKit driver executable."""
         try:
             super().quit()
         except http_client.BadStatusLine:

py/test/selenium/webdriver/common/interactions_tests.py

@@ -209,9 +209,7 @@ def test_sending_keys_to_element(driver, pages):
 
 
 def test_can_send_keys_between_clicks(driver, pages):
-    """For W3C, ensures that the correct number of pauses are given to the other
-    input device.
-    """
+    """Ensure W3C sends correct pause count to other input devices."""
     pages.load("javascriptPage.html")
     keyup = driver.find_element(By.ID, "keyUp")
     keydown = driver.find_element(By.ID, "keyDown")

py/test/selenium/webdriver/common/interactions_with_device_tests.py

@@ -194,9 +194,7 @@ def test_sending_keys_to_element_with_keyboard(driver, pages):
 
 
 def test_can_send_keys_between_clicks_with_keyboard(driver, pages):
-    """For W3C, ensures that the correct number of pauses are given to the other
-    input device.
-    """
+    """Ensure W3C sends correct pause count to other input devices."""
     pages.load("javascriptPage.html")
     keyup = driver.find_element(By.ID, "keyUp")
     keydown = driver.find_element(By.ID, "keyDown")

py/test/selenium/webdriver/common/page_loader.py

@@ -15,10 +15,10 @@
 # specific language governing permissions and limitations
 # under the License.
 
-"""This module contains some decorators that can be used to support
-the page models. For example for an action that needs a page to be fully
-loaded, the @require_loaded decorator will make sure the page is loaded
-before the call is invoked.
+"""This module contains some decorators that can be used to support the page models.
+
+For example for an action that needs a page to be fully loaded, the @require_loaded
+decorator will make sure the page is loaded before the call is invoked.
 This pattern is also useful for waiting for certain asynchronous events
 to happen before executing certain actions.
 """

py/test/selenium/webdriver/common/webdriverwait_tests.py

@@ -364,8 +364,10 @@ def test_expected_condition_attribute_to_be_include_in_element(driver, pages):
 
 
 def test_driver_with_http_timeout(driver, pages):
-    """This test starts a webdriver with an http client timeout set less than the implicit
-    wait, and verifies the http timeout is triggered first when waiting for an element.
+    """This test starts a webdriver with an http client timeout.
+
+    It verifies the http timeout is triggered first when waiting for an element,
+    with the timeout set less than the implicit wait.
     """
     pages.load("simpleTest.html")
     driver.command_executor.client_config.timeout = 6

py/test/selenium/webdriver/common/webserver.py

@@ -16,6 +16,7 @@
 # under the License.
 
 """A simple web server for testing purpose.
+
 It serves the testing html pages that are needed by the webdriver unit tests.
 """