[py] update documentation for find_element methods to remove 'private…

…' indication
SeleniumHQ · May 12, 2018 · 2c2db8a · 2c2db8a
1 parent 0e1b72d
commit 2c2db8a
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 8 deletions.
diff --git a/py/selenium/webdriver/remote/webdriver.py b/py/selenium/webdriver/remote/webdriver.py
@@ -933,10 +933,11 @@ def set_page_load_timeout(self, time_to_wait):
 
     def find_element(self, by=By.ID, value=None):
         """
-        'Private' method used by the find_element_by_* methods.
+        Find an element given a By strategy and locator. Prefer the find_element_by_* methods when
+        possible.
 
         :Usage:
-            Use the corresponding find_element_by_* instead of this.
+            element = driver.find_element(By.ID, 'foo')
 
         :rtype: WebElement
         """
@@ -958,10 +959,11 @@ def find_element(self, by=By.ID, value=None):
 
     def find_elements(self, by=By.ID, value=None):
         """
-        'Private' method used by the find_elements_by_* methods.
+        Find elements given a By strategy and locator. Prefer the find_elements_by_* methods when
+        possible.
 
         :Usage:
-            Use the corresponding find_elements_by_* instead of this.
+            elements = driver.find_elements(By.CLASS_NAME, 'foo')
 
         :rtype: list of WebElement
         """

diff --git a/py/selenium/webdriver/remote/webelement.py b/py/selenium/webdriver/remote/webelement.py
@@ -629,10 +629,11 @@ def _execute(self, command, params=None):
 
     def find_element(self, by=By.ID, value=None):
         """
-        'Private' method used by the find_element_by_* methods.
+        Find an element given a By strategy and locator. Prefer the find_element_by_* methods when
+        possible.
 
         :Usage:
-            Use the corresponding find_element_by_* instead of this.
+            element = element.find_element(By.ID, 'foo')
 
         :rtype: WebElement
         """
@@ -654,10 +655,11 @@ def find_element(self, by=By.ID, value=None):
 
     def find_elements(self, by=By.ID, value=None):
         """
-        'Private' method used by the find_elements_by_* methods.
+        Find elements given a By strategy and locator. Prefer the find_elements_by_* methods when
+        possible.
 
         :Usage:
-            Use the corresponding find_elements_by_* instead of this.
+            element = element.find_elements(By.CLASS_NAME, 'foo')
 
         :rtype: list of WebElement
         """