Refactor a few docstrings

Author: mdmintz

seleniumbase/common/decorators.py

@@ -24,8 +24,7 @@ def my_method():
 
         with decorators.print_runtime("My Code Block"):
             # code ...
-            # code ...
-    """
+            # code ... """
     if not description:
         description = "Code Block"
     description = str(description)
@@ -68,8 +67,7 @@ def my_method():
 
 @contextmanager
 def runtime_limit(limit, description=None):
-    """
-    Fail if the runtime duration of a method or "with"-block exceeds the limit.
+    """Fail if the runtime duration of a method or "with"-block exceeds limit.
     (The failure won't occur until after the method or "with"-block completes.)
 
     Method / Function example usage ->
@@ -85,8 +83,7 @@ def my_method():
 
         with decorators.runtime_limit(32):
             # code ...
-            # code ...
-    """
+            # code ... """
     limit = float("%.2f" % limit)
     if limit < 0.01:
         limit = 0.01  # Minimum runtime limit
@@ -115,14 +112,12 @@ def my_method():
 
 
 def retry_on_exception(tries=6, delay=1, backoff=2, max_delay=32):
-    """
-    Decorator for implementing exponential backoff for retrying on failures.
+    """Decorator for implementing exponential backoff for retrying on failures.
 
     tries: Max number of tries to execute the wrapped function before failing.
     delay: Delay time in seconds before the FIRST retry.
     backoff: Multiplier to extend the initial delay by for each retry.
-    max_delay: Max time in seconds to wait between retries.
-    """
+    max_delay: Max time in seconds to wait between retries."""
     tries = math.floor(tries)
     if tries < 1:
         raise ValueError('"tries" must be greater than or equal to 1.')

seleniumbase/core/detect_b_ver.py

@@ -1,7 +1,5 @@
-"""
-Detect the browser version before launching tests.
-Eg. detect_b_ver.get_browser_version_from_os("google-chrome")
-"""
+"""Detect the browser version before launching tests.
+Eg. detect_b_ver.get_browser_version_from_os("google-chrome")"""
 import datetime
 import os
 import platform

seleniumbase/utilities/selenium_ide/convert_ide.py

@@ -1,5 +1,4 @@
-"""
-Converts a Selenium IDE recording that was exported as a Python WebDriver
+"""Converts a Selenium IDE recording that was exported as a Python WebDriver
 unittest file into SeleniumBase Python file.
 Works with Katalon Recorder scripts: http://www.katalon.com/automation-recorder
 
@@ -11,8 +10,7 @@
                 (when run from the "selenium_ide/" folder)
 Output:
         [NEW_FILE_SB].py  (adds "_SB" to the original file name)
-                          (the original file is kept intact)
-"""
+                          (the original file is kept intact)"""
 import codecs
 import re
 import sys