Deprecate keywords (#1188)

Deprecated keywords with warning, which where deprecated silently in SeleniumLibrary 3.0.

Author: aaltat

atest/acceptance/keywords/lists.robot

@@ -74,7 +74,6 @@ List Selection Should Be When List Does Not Exist
     ...    List Selection Should Be    nonexisting    whatever
 
 UnSelect Single Value From List
-    [Documentation]    LOG 2.1 Unselecting option(s) 'Email' from list 'possible_channels'.
     Unselect and Verify Selection    possible_channels    Email    phone
     # Unselecting already unselected option has no effect
     Unselect and Verify Selection    possible_channels    Email    phone
@@ -84,7 +83,6 @@ UnSelect Single Value From List
     ...    Unselect From List    preferred_channel
 
 Unselect all options using Unselect From List
-    [Documentation]    LOG 2 Unselecting all options from list 'possible_channels'.
     Unselect From List    possible_channels
     List Should Have No Selections    possible_channels
 
@@ -99,12 +97,11 @@ Unselect All From List
     List Should Have No Selections    interests
 
 Select From Single Selection List
-    [Documentation]    LOG 2.1 Selecting option(s) 'Email' from list 'preferred_channel'.
     Select And verify selection    preferred_channel    Email    Email
     Select And verify selection    preferred_channel    Email    Email
     Select And verify selection    preferred_channel    directmail    Direct mail
     Select From List    preferred_channel    Telephone
-    # do something else... anything to ensure the list is really set as the next keyword will pass 
+    # do something else... anything to ensure the list is really set as the next keyword will pass
     # if list item is highlighted but not selected
     Unselect from List    possible_channels
     List Selection Should Be    preferred_channel    Telephone
@@ -135,12 +132,10 @@ Select Non-Existing Item From Multi-Selection List
     ...    Select From List    possible_channels    Tin Can Phone    Email    Smoke Signals
 
 Unselect Non-Existing Item From List
-    [Documentation]    LOG 3 Unselecting option(s) 'Tin Can Phone, Smoke Signals, Email' from list 'possible_channels'.
     Unselect From List    possible_channels    Tin Can Phone    Smoke Signals
     Unselect From List    possible_channels    Tin Can Phone    Smoke Signals    Email
 
 Select From Multiselect List
-    [Documentation]    LOG 6 Selecting option(s) 'Direct mail, phone' from list 'possible_channels'.
     Select And verify selection    possible_channels    Email    Email    Telephone
     Select And verify selection    possible_channels    email    email    phone
     Select And verify selection    possible_channels    Direct mail    Direct mail    Email    Telephone

src/SeleniumLibrary/keywords/alert.py

@@ -30,11 +30,12 @@ class AlertKeywords(LibraryComponent):
 
     @keyword
     def input_text_into_prompt(self, text):
-        """Deprecated. Use `Input Text Into Alert` instead.
+        """*DEPRECATED in SeleniumLibrary 3.2.* Use `Input Text Into Alert` instead.
 
         Types the given ``text`` into an input field in an alert.
         Leaves the alert open.
         """
+
         self.input_text_into_alert(text, self.LEAVE)
 
     @keyword
@@ -99,7 +100,7 @@ def alert_should_not_be_present(self, action=ACCEPT, timeout=0):
 
     @keyword
     def choose_cancel_on_next_confirmation(self):
-        """Deprecated. Use `Handle Alert` directly instead.
+        """*DEPRECATED in SeleniumLibrary 3.2.* Use `Handle Alert` directly instead.
 
         In versions prior to SeleniumLibrary 3.0, the alert handling
         approach needed to be set separately before using the `Confirm
@@ -110,7 +111,7 @@ def choose_cancel_on_next_confirmation(self):
 
     @keyword
     def choose_ok_on_next_confirmation(self):
-        """Deprecated. Use `Handle Alert` directly instead.
+        """*DEPRECATED in SeleniumLibrary 3.2.* Use `Handle Alert` directly instead.
 
         In versions prior to SeleniumLibrary 3.0, the alert handling
         approach needed to be set separately before using the `Confirm
@@ -121,7 +122,7 @@ def choose_ok_on_next_confirmation(self):
 
     @keyword
     def confirm_action(self):
-        """Deprecated. Use `Handle Alert` instead.
+        """*DEPRECATED in SeleniumLibrary 3.2.* Use `Handle Alert` instead.
 
         By default accepts an alert, but this behavior can be altered
         with `Choose Cancel On Next Confirmation` and `Choose Ok On Next
@@ -135,7 +136,7 @@ def confirm_action(self):
 
     @keyword
     def get_alert_message(self, dismiss=True):
-        """Deprecated. Use `Handle Alert` instead.
+        """*DEPRECATED in SeleniumLibrary 3.2.* Use `Handle Alert` instead.
 
         Returns the message the alert has. Dismisses the alert by default
         (i.e. presses ``Cancel``) and setting ``dismiss`` to false leaves
@@ -150,7 +151,7 @@ def get_alert_message(self, dismiss=True):
 
     @keyword
     def dismiss_alert(self, accept=True):
-        """Deprecated. Use `Handle Alert` instead.
+        """*DEPRECATED in SeleniumLibrary 3.2.* Use `Handle Alert` instead.
 
         Contrary to its name, this keyword accepts the alert by default
         (i.e. presses ``Ok``). ``accept`` can be set to a false value

src/SeleniumLibrary/keywords/cookie.py

@@ -54,7 +54,7 @@ def get_cookies(self):
 
     @keyword
     def get_cookie_value(self, name):
-        """Deprecated. Use `Get Cookie` instead."""
+        """*DEPRECATED in SeleniumLibrary 3.2.* Use `Get Cookie` instead."""
         cookie = self.driver.get_cookie(name)
         if cookie is not None:
             return cookie['value']

src/SeleniumLibrary/keywords/element.py

@@ -550,7 +550,7 @@ def set_focus_to_element(self, locator):
 
     @keyword
     def focus(self, locator):
-        """Deprecated. Use `Set Focus To Element` instead."""
+        """*DEPRECATED in SeleniumLibrary 3.2.* Use `Set Focus To Element` instead."""
         self.set_focus_to_element(locator)
 
     @keyword
@@ -689,7 +689,7 @@ def simulate_event(self, locator, event):
 
     @keyword
     def simulate(self, locator, event):
-        """Deprecated. Use `Simulate Event` instead."""
+        """*DEPRECATED in SeleniumLibrary 3.2.* Use `Simulate Event` instead."""
         self.simulate_event(locator, event)
 
     @keyword
@@ -825,13 +825,13 @@ def page_should_not_contain_image(self, locator, message=None, loglevel='INFO'):
 
     @keyword
     def get_matching_xpath_count(self, xpath, return_str=True):
-        """Deprecated. Use `Get Element Count` instead."""
+        """*DEPRECATED in SeleniumLibrary 3.2.* Use `Get Element Count` instead."""
         count = self.get_element_count('xpath:' + xpath)
         return str(count) if is_truthy(return_str) else count
 
     @keyword
     def xpath_should_match_x_times(self, xpath, x, message=None, loglevel='INFO'):
-        """Deprecated, use `Page Should Contain Element` with ``limit`` argument instead."""
+        """*DEPRECATED in SeleniumLibrary 3.2.* Use `Page Should Contain Element` with ``limit`` argument instead."""
         self.locator_should_match_x_times('xpath:'+xpath, x, message, loglevel)
 
     @keyword

src/SeleniumLibrary/keywords/frames.py

@@ -65,7 +65,7 @@ def current_frame_should_contain(self, text, loglevel='INFO'):
 
     @keyword
     def current_frame_contains(self, text, loglevel='INFO'):
-        """Deprecated. Use `Current Frame Should Contain` instead."""
+        """*DEPRECATED in SeleniumLibrary 3.2.* Use `Current Frame Should Contain` instead."""
         self.current_frame_should_contain(text, loglevel)
 
     @keyword

src/SeleniumLibrary/keywords/selectelement.py

@@ -191,7 +191,7 @@ def select_all_from_list(self, locator):
 
     @keyword
     def select_from_list(self, locator, *options):
-        """Deprecated. Use `Select From List By Label/Value/Index` instead.
+        """*DEPRECATED in SeleniumLibrary 3.2.* Use `Select From List By Label/Value/Index` instead.
 
         This keyword selects options based on labels or values, which makes
         it very complicated and slow. It has been deprecated in
@@ -307,7 +307,7 @@ def unselect_all_from_list(self, locator):
 
     @keyword
     def unselect_from_list(self, locator, *items):
-        """Deprecated. Use `Unselect From List By Label/Value/Index` instead.
+        """*DEPRECATED in SeleniumLibrary 3.2.* Use `Unselect From List By Label/Value/Index` instead.
 
         This keyword unselects options based on labels or values, which makes
         it very complicated and slow. It has been deprecated in

src/SeleniumLibrary/keywords/window.py

@@ -127,7 +127,7 @@ def get_window_handles(self):
 
     @keyword
     def list_windows(self):
-        """Deprecated. Use `Get Window Handles` instead."""
+        """*DEPRECATED in SeleniumLibrary 3.2.* Use `Get Window Handles` instead."""
         return self.get_window_handles()
 
     @keyword